Get membership metadata

Your app's subscribe key from Admin Portal.

A UTF-8 encoded string used to identify the client. Must not be empty and can contain up to 92 UTF-8 byte sequences.

Prohibited characters are: ,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero.

Possible values: [custom, type, status, channel, channel.custom, channel.status, channel.type]

List of additional/complex metadata to include in the response. Omit this query parameter if you don't want to retrieve additional metadata.

Possible values: value ≤ 100

Number of objects to return in response. Default is 100, which is also the maximum value.

Random 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.

Random 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 start parameter is provided.

Request totalCount to be included in the paginated response. By default, totalCount is omitted.

Expression 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:

• Date/time properties, such as updated, must be compared to valid date/time strings formatted according to ISO 8601.
• Custom properties must have the same type as the value used in the expression; it is an error to compare a custom property of one type to another.
• Objects that do not have the referenced custom property are excluded regardless of the operator or value used in the expression. The null value can be used to filter out objects that do or do not have the referenced custom property.
• The LIKE operator supports wildcards denoted by the * character. A wildcard matches any sequence of arbitrary Unicode characters, including the empty sequence. The literal asterisk is matched when escaped using the backslash (\) character.
• Values used with LIKE must be properly encoded just like any other string value. Thus, to escape an asterisk, the raw value must contain \\*.
• The entire expression must be properly URL-encoded when used in the query string.

Possible values: Value must match regular expression ^[^:]+(:(asc|desc))?$

List of properties to sort by. Append :asc or :desc to a property to specify sort direction. The default sort direction is ascending.

Example: updated,status,type,channel.id,channel.name,channel.updated,channel.status,channel.type

String 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 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.

Unix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP. Required if signature parameter is supplied.