200
Successfully returned the channel members' metadata. Schema — OPTIONAL |
---|
data object[] — OPTIONALList of returned objects. uuid object — OPTIONALObject with UUID metadata used in responses. id string — OPTIONALPossible values: 1 ≤ length ≤ 92 A UTF-8 encoded string used to identify the client. Must not be empty, and may contain up to 92 UTF-8 byte sequences. Prohibited characters are: , , / , \ , * , : , channel, non-printable ASCII control characters, and Unicode zero. | name string — OPTIONALPossible values: 1 ≤ length Name of the UUID. Max. 2,048 characters. Must not be empty or consist only of whitespace characters. | externalId string — OPTIONALUUID's identifier in an external system. Max. 2,048 characters. | profileUrl uri — OPTIONALURL for the UUID's profile picture. Max. 2,048 characters. Syntax is as defined in RFC 3986. | email email — OPTIONALThe UUID's email address. Max. 320 characters. Syntax is as defined by RFC 5322 and extended by RFC 6532, with one exception: the display-name part is not allowed (only the addr-spec part is allowed). | type string — OPTIONALUser type. Max. 50 characters. | status string — OPTIONALUser status. Max. 50 characters. | custom object — OPTIONALJSON object of key/value pairs with supported data-types. Values must be scalar only; arrays or objects are not supported. NOTE: If you set custom fields with integer values, do not specify numbers larger than 9007199254740991 due to precision limitations in JSON implementations. For large integer values, for example PubNub timetoken values, use string values instead of integers. | updated date-time — OPTIONALDate and time the object was last updated. | eTag string — OPTIONALInformation on the object's content fingerprint. NOTE: eTag from GET requests can be used alongside the If-Match HTTP header in conditional PATCH requests in users/channels' metadata APIs. This functionality is currently not supported in the membership/members' metadata APIs. |
| type string — OPTIONALMembership type. Max. 50 characters. | status string — OPTIONALMembership status. Max. 50 characters. | custom object — OPTIONALJSON object of key/value pairs with supported data-types. Values must be scalar only; arrays or objects are not supported. NOTE: If you set custom fields with integer values, do not specify numbers larger than 9007199254740991 due to precision limitations in JSON implementations. For large integer values, for example PubNub timetoken values, use string values instead of integers. | updated date-time — OPTIONALDate and time the object was last updated. | eTag string — OPTIONALInformation on the object's content fingerprint. NOTE: eTag from GET requests can be used alongside the If-Match HTTP header in conditional PATCH requests in users/channels' metadata APIs. This functionality is currently not supported in the membership/members' metadata APIs. |
| status integer — OPTIONAL | totalCount integer — OPTIONALTotal count of objects without pagination. | next string — OPTIONALRandom 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. | prev string — OPTIONALRandom 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. |
|
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. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable. | locationType string — OPTIONALPossible values: [path , query , header , body ] |
|
|
|
429
Request rate limit exceeded. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable. | locationType string — OPTIONALPossible values: [path , query , header , body ] |
|
|
|
500
An internal server error occurred. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable. | locationType string — OPTIONALPossible values: [path , query , header , body ] |
|
|
|
503
Request processing exceeded the maximum allowed time. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable. | locationType string — OPTIONALPossible values: [path , query , header , body ] |
|
|
|