Get metadata for all users
Returns a paginated list of UUID metadata, optionally including custom properties.
Path Parameters |
---|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. |
Query Parameters |
---|
include string[]Possible values: [ List of additional/complex UUID metadata to include in the response. Omit this query parameter if you don't want to retrieve additional metadata. |
limit integerPossible values: value ≤ 100 Number of objects to return in response. Default is |
start stringRandom string returned from the server, including a specific position in a data set. Used for forward pagination, it fetches the next page, allowing you to continue from where you left off. |
end stringRandom string returned from the server, including a specific position in a data set. Used for backward pagination, it fetches the previous page, enabling access to earlier data. Ignored if the |
count booleanRequest |
filter stringExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. For details on App Context Filtering, refer to documentation. Note the following:
Example (Simple expression):
Example (Date/time comparison):
Example (Compound expression):
Example (Wildcard):
Example (Escaped wildcard):
|
sort string[]Possible values: Value must match regular expression List of properties to sort by.
Append Example:
|
auth stringString which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Authorization token with permissions to perform the request. |
signature stringSignature used to verify that the request was signed with the secret key associated with the subscribe key. If Access Manager is enabled, either a valid authorization token or a signature are required. Check Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP.
Required if |
Responses | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 Successfully returned the list of UUID metadata.
| ||||||||||||||||
304 Requested resource has not been modified since the last retrieval. | ||||||||||||||||
403 Disabled - The subscribe key doesn't have App Context API enabled. Forbidden - The client isn't authorized to perform this operation. The authorization key you provided doesn't have the required permissions for this operation.
| ||||||||||||||||
429 Request rate limit exceeded.
| ||||||||||||||||
500 An internal server error occurred.
| ||||||||||||||||
503 Request processing exceeded the maximum allowed time.
|