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

    View metadata

    Retrieves one or more items of a channel's metadata that are stored in a channel.

    Note: See this page to learn more about differences among data properties.


    HTTP request

    // When retrieving all items of a channel metadata
    GET https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metadata
    
    // When retrieving a specific item of a channel metadata by its key
    GET https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/metadata/{key}
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_type

    string

    Specifies the type of a channel. Acceptable values are open_channels and group_channels.

    channel_url

    string

    Specifies the URL of a channel.

    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 matches the parameter value is returned. Urlencoding a key is recommended.

    keys

    array of strings

    In a query string, specifies an array of one or more keys of the metadata items. If not specified, all items of the metadata are returned. If specified, only the items that match the parameter values are returned. Urlencoding each key is recommended (for example, ?keys=urlencoded_key_1, urlencoded_key_2).

    ../metadata?keys=background_image,description
    

    Response

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

    {
        "background_image": "https://sendbird.com/main/img/bg/theme_013.png",
        "description": "A chat room for discussing the upcoming project."
    }
    

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