Get metadata

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.

// When retrieving all items of the user metadata.
GET https://api-{application_id}.sendbird.com/v3/users/{user_id}/metadata

// When retrieving a specific item by its key of the user metadata.
GET https://api-{application_id}.sendbird.com/v3/users/{user_id}/metadata/{key}

The following table lists the parameters that this action supports.

../metadata?keys=font_preference,font_color

If successful, this action returns items of the metadata in the response body.

{
    "font_preference": "times new roman",
    "font_color": "gray" 
}

In the case of an error, an error object like below is returned. See the error codes section for more details.

{
    "message": "\"User\" not found.",
    "code": 400201,
    "error": true
}