The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
searchstringOptional
The search value for this operation. Its accepted type and constraints are listed above and below.
maxLength: 200 · default: ""
tagstringOptional
The tag value for this operation. Its accepted type and constraints are listed above and below.
maxLength: 40 · default: ""
planIduuid | ""Optional
The products.id of a membership product in the current App and environment; combined with versionId, it selects membership holdings and schedules.
default: ""
versionIduuid | ""Optional
Immutable product_versions.id, including historical versions.
default: ""
holdingStatusenumOptional
Filter verified membership periods and confirmed renewal schedules by active, scheduled, expired or unavailable; none means no currently active membership.
default: ""
Show allowed values
"""active""scheduled""expired""unavailable""none"
membershipStatusenumOptional
Filter canonical membership records by active, trial, past_due or ended; an empty string includes all statuses.
default: ""
Show allowed values
"""active""trial""past_due""ended"
createdFromdate-time | ""Optional
The createdFrom value for this operation. Its accepted type and constraints are listed above and below.
default: ""
createdUntildate-time | ""Optional
The createdUntil value for this operation. Its accepted type and constraints are listed above and below.
default: ""
offsetintegerOptional
Record offset, starting at 0.
min: 0 · max: 100000 · default: 0
limitintegerOptional
Maximum records per page, subject to the contract limit.
min: 1 · max: 100 · default: 50
Response fields
Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json
requestIduuidRequired
Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobjectRequired
The App and environment of this response. Headers only verify scope; they cannot switch key scope.
Show child fields
projectIdstringRequired
App ID bound to the credential.
minLength: 1
environmentenumRequired
Separate data scope: sandbox or live.
Show allowed values
"sandbox""live"
customersarrayRequired
The customers value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
externalUserIdstring | nullRequired
Stable user ID from your server-authenticated login system, not an email address. null for a customer reserved by email and not yet claimed.
namestringRequired
Display name of the customer or object; not an identity key.
maxLength: 80
emailemail | ""Required
Customer contact email; not used to merge customer identities.
attributesobjectRequired
Up to 128 keys, 1–128 characters each, and 64 KiB total JSON. Values may contain nested JSON, limited to 20 levels and 10,000 nodes per value. Reserved fields are rejected. Null is a value; delete keys with removeAttributes. Tags live in attributes.tags and change through tagChanges.
revisionintegerRequired
Revision returned by profile reads; updates use it to detect concurrent changes.
min: 0 · max: 9007199254740991
createdAtdate-timeRequired
ISO 8601 UTC time when the record was created.
updatedAtdate-timeRequired
ISO 8601 UTC time of the last record update.
hasMorebooleanRequired
Whether another page exists; continue with the returned cursor or pagination parameters.
totalinteger | nullRequired
The total value for this operation. Its accepted type and constraints are listed above and below.
evaluatedAtdate-timeRequired
UTC server time at which this state was evaluated.
Handle errors
Common failures
Code
Recovery
UNAUTHENTICATED
Verify the key or refresh the expired customer token once.
FORBIDDEN
Check current key permissions and customer access.
INVALID_REQUEST
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Use the App and environment bound to the credential.
Common failures
UNAUTHENTICATED
Recovery
Verify the key or refresh the expired customer token once.
FORBIDDEN
Recovery
Check current key permissions and customer access.
INVALID_REQUEST
Recovery
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Recovery
Use the App and environment bound to the credential.