List chat_groups | Hume API

Fetches a paginated list of Chat Groups.

Authentication

X-Hume-Api-Keystring

API Key authentication via header

Query parameters

• page_number integer Optional
  Defaults to 0
  Specifies the page number to retrieve, enabling pagination. This parameter uses zero-based indexing. For example, setting page_number to 0 retrieves the first page of results (items 0-9 if page_size is 10), setting page_number to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.

• page_size integer Optional
  Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
  For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

• ascending_order boolean Optional
  Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.

• config_id string Optional format: "uuid"
  The unique identifier for an EVI configuration.
  Filter Chat Groups to only include Chats that used this config_id in their most recent Chat.

Response

Success

• chat_groups_page list of objects
  List of Chat Groups and their metadata returned for the specified page_number and page_size.

Show 7 properties

• page_number integer
  The page number of the returned list.
  This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

• page_size integer
  The maximum number of items returned per page.
  This value corresponds to the page_size parameter specified in the request.

• pagination_direction enum
  Allowed values: ASC, DESC

• total_pages integer
  The total number of pages in the collection.