You can retrieve a specific or all metadata of a user. Metadata stores additional user information such as their preference settings.
Note: Do not use PII (Personally Identifiable Information) such as user email address, legal name, or phone number for data security and privacy reason.
The following table lists the parameters that this action supports.
Specifies the unique ID of a user.
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.
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.