Channel Groups

The following endpoints are part of the Channels API and allow you to manage channel groups, specifically for the WhatsApp platform. Channel groups are used to group together channel IDs that belong to the same WhatsApp account. This documentation will provide details on how to interact with these endpoints.

List available channel groups

This endpoint retrieves a list of all available channel groups within a workspace. The response includes information such as the unique identifier of each channel group, the WhatsApp platform ID, the platform group ID, the platform group name, and the list of channel IDs associated with the channel group.

List available channel groups

get

Retrieve a list of all channel groups

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

Responses

200

List of available channel groups is returned

application/json

get

/workspaces/{workspaceId}/channel-groups

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/channel-groups HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

200

List of available channel groups is returned

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "platformGroupId": "text",
      "platformGroupName": "text",
      "platformId": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "2026-03-05T00:03:47.871Z",
      "updatedAt": "2026-03-05T00:03:47.871Z"
    }
  ]
}

Get channel group by ID

This endpoint gets a channel group by group ID and lists all the channels related to the group

Get channel group by ID

get

Retrieve channel group by it's type

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

channelGroupIdstring · uuidRequired

The ID for a channel group

Responses

200

Return channel group

application/json

idstring · uuidOptional

platformGroupIdstring · min: 1 · max: 250Optional

platformGroupNamestring · min: 1 · max: 250Optional

platformIdstring · min: 3 · max: 60OptionalPattern: ^[A-Za-z0-9-]+$

channelIdsstring · uuid[]Optional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

404

The request did not pass validation

application/json

get

/workspaces/{workspaceId}/channel-groups/{channelGroupId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/channel-groups/{channelGroupId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "platformGroupId": "text",
  "platformGroupName": "text",
  "platformId": "text",
  "channelIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "2026-03-05T00:03:47.871Z",
  "updatedAt": "2026-03-05T00:03:47.871Z"
}