Skip to main content

List dictionaries



Lists all dictionaries currently available in the chatroom. Authorization requires either the chatroom token with admin role or the dictionary token.


Query Parameters

    page_size int32

    Maximum value: 100. Default value: 10.

    page_token string

    A page token, received from a previous ListDictionaries API call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDictionaries must match the call that provided the page token.

Header Parameters

    authorization string

    This API should be invoked with the chatroom token or dictionary token.


A successful response.

    dictionaries object[]
  • Array [
  • id string

    Output only. The uuid of the dictionary that is used to filter the incoming message from the viewer.

    name string

    Output only. The name of the dictionary.

    description string

    Output only. The description of the dictionary.

    default boolean

    Output only. Indicates the dictionary is the default dictionary that can not be modified or deleted.

    pattern_count int32

    Output only. The number of patterns in the dictionary.

    created_at date-time

    Output only. Indicates the time that the dictionary created.

    updated_at date-time

    Output only. Indicates the time that the dictionary last updated.

  • ]
  • next_page_token string

    A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.