Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API

    View metadata

    Retrieves a specific item or all items of the metadata of a user.


    HTTP request

    // 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}
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    user_id

    string

    Specifies the unique ID of a user.

    OptionalTypeDescription

    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.

    ../metadata?keys=location,marriage
    

    Response

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

    {
        "location": "Washington",
        "marriage": "N"
    }
    

    In the case of an error, an error object is returned. A detailed list of error codes is available here.