whatsapp-groups

List WhatsApp groups

Returns the WhatsApp groups your workspace created as a cursor-paginated list, newest first. Each group carries the number that administers it, its subject, its status, its invite link once WhatsApp has issued one, its participant count, and its participant list.

Filter by the business number that administers the groups (number), by the WhatsApp Business Account that number sends under (waba), or by status. q searches the subject and the description for a substring, case-insensitively.

A group stays in the list after it is deleted, with status deleted, so filter it out to see only the groups you can still message.

get/v1/whatsapp/groups

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/whatsapp/groups
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

sort'created_at'

Sortable fields for a WhatsApp group list.

Field to sort by.

order'asc' | 'desc'

Sort direction, ascending or descending.

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

numberstring

Filter by the business number that administers the group, as either the number in E.164 format or the number's id (wan_ prefix). A value that parses as a valid ID resolves by ID; any other value must be an E.164 number, and anything else is a 422. The E.164 form is matched against the group's stored record of the number it was created on.

wabastring

Filter by the WABA identifier returned on the group. Groups with waba: null do not match this filter.

qstring

Case-insensitive substring match against the group's subject or description.

statusWhatsAppGroupStatus[]

Filter by status. Repeat the parameter to match any of several statuses.

[
  "active"
]
limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

created_afterstring date-time
Example:2026-05-01T00:00:00Z

Limits the response to resources created at or after this timestamp. Combine it with created_before to select a time window. Use an RFC 3339 timestamp with a timezone offset.

created_beforestring date-time
Example:2026-06-01T00:00:00Z

Limits the response to resources created before this timestamp. Combine it with created_after to select a time window. Use an RFC 3339 timestamp with a timezone offset.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

A page of the WhatsApp groups your workspace created.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "id": "wag_01krdgeqcxet5s7t44vh8rt9mg",
      "whatsapp_number_id": "wan_01krdgeqcxet5s7t44vh8rt9mg",
      "waba": "102290129340398",
      "subject": "New Purchase Inquiry",
      "description": "Jim would like to learn about new car purchase options for current year models.",
      "status": "active",
      "join_approval_mode": "auto_approve",
      "invite_link": "https://chat.whatsapp.com/JZm4S9tCkQx2LpVr7Ny8Ab",
      "participants": [
        {
          "bsuid": "US.1566655121691972",
          "phone_number": "+16505551234",
          "username": "john.doe",
          "last_operation": {
            "type": "settings_update",
            "status": "pending",
            "requested_at": "2026-08-27T14:02:11Z",
            "settled_at": "2026-08-27T14:02:14Z",
            "results": [
              {
                "field": "subject",
                "error": {
                  "description": "Group subject contains content that cannot be used.",
                  "meta_error_code": "2388024"
                }
              }
            ],
            "last_error": {
              "description": "Group subject contains content that cannot be used.",
              "meta_error_code": "2388024"
            }
          }
        }
      ],
      "participant_count": 6,
      "pinned_messages": [
        {
          "message_id": "wam_01krdgeqcxet5s7t44vh8rt9mg",
          "pinned_until": "2026-09-01T09:14:52Z"
        }
      ],
      "profile_picture_url": "https://media.example.com/whatsapp/groups/JZm4S9tCkQx2.jpg",
      "last_operation": {
        "type": "settings_update",
        "status": "pending",
        "requested_at": "2026-08-27T14:02:11Z",
        "settled_at": "2026-08-27T14:02:14Z",
        "results": [
          {
            "field": "subject",
            "error": {
              "description": "Group subject contains content that cannot be used.",
              "meta_error_code": "2388024"
            }
          }
        ],
        "last_error": {
          "description": "Group subject contains content that cannot be used.",
          "meta_error_code": "2388024"
        }
      },
      "suspended_at": "2026-08-20T11:04:00Z",
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.