You can retrieve a specific or all metadata of a user. Metadata stores additional user information such as phone number, email or a description of the user.
The following table lists the parameters that this action supports.
Parameters
Required | Type | Description |
---|---|---|
user_id | string | Specifies the unique ID of a user. |
Optional | Type | Description |
---|---|---|
key | string | Specifies the key of a metadata item. If not specified, all items of the metadata are returned. If specified, only the item that has the specified value is returned. Urlencoding a key is recommended. |
keys | array | Specifies an array of one or more keys for items of the metadata. If not specified, all items of the metadata are returned. If specified, only the items that have the specified values are returned. Urlencoding each key is recommended. |
If successful, this action returns items of the metadata in the response body.
In the case of an error, an error object like below is returned. See the error codes section for more details.