Sign inGet Started
立即开始
指南
API 参考
SDK
CLI
知识库
更新日志

List WhatsApp groups

GET
/v1/whatsapp/groups
for await (const group of bird.whatsapp.groups.list()) {
  console.log(group.id, group.subject, group.participant_count);
}
响应200
{
  "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",
            "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",
            "applied": false,
            "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",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

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.

查询参数

sortstring

Field to sort by.

Possible values: created_at

orderstring

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

Possible values: asc, desc

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.

statusarray

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

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

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

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.

响应载荷

data
array of object
必填

The groups your workspace created, newest first.

显示子属性
data.id
string
必填

Unique identifier for the group. Accepted by every /v1/whatsapp/groups/{group_id} operation, and as to when sending a message to the group.

data.whatsapp_number_id
string
必填

The business number that created the group. It is the group's admin and the number every message to the group is sent from. Fixed when the group is created.

data.waba
nullable string
必填

Meta's identifier for the WhatsApp Business Account recorded when the group was created. This is a historical snapshot, not a live account directory projection. Null for a number we operate on your behalf, whose account is not yours to see.

data.subject
string
必填

The group's name, shown to participants and to anyone who opens the invite link.

data.description
nullable string

The group's description, shown alongside the subject. Null when the group has none.

data.status
string
必填

Where the group stands. A group is messageable only while it is active.

data.join_approval_mode
string
必填

Whether opening the invite link joins the group outright or raises a join request to approve.

data.invite_link
nullable string

The link that lets someone join the group, which is the only way in. A group has one link at a time. Null while the group is pending, since WhatsApp issues the link when it confirms the group. Rotating it through POST /v1/whatsapp/groups/{group_id}/invite-link/rotate replaces it, and every link the group had before then stops working.

data.participants
array of object

Who is in the group, as of the last update WhatsApp sent, and the whole set rather than a page: WhatsApp holds a group to a handful of people, so there is never a page's worth to return. The business number that created the group is its admin and is not listed.

显示子属性
data.participant_count
integer
必填

How many people are in the group, excluding your business.

data.pinned_messages
array of object

The group's pins, newest first. WhatsApp holds a few at once, and pinning past that unpins the oldest rather than refusing. No entry here is merely requested. An entry stays listed until it is unpinned, so one whose pinned_until has passed is still listed after WhatsApp has taken it off the chat.

显示子属性
data.pinned_messages.message_id
string
必填

The pinned message, as returned in the send response's id.

data.pinned_messages.pinned_until
string
必填

When the pin is due to lapse, projected from the duration_days the pin was asked for. An entry stays listed until it is unpinned, so a time in the past means WhatsApp has already taken the message off the chat.

data.profile_picture_url
nullable string

Address of the group's picture, as WhatsApp serves it. Null when the group has none.

data.last_operation
object

The last create, settings change or delete asked of the group. pending while WhatsApp has yet to confirm it, which is what a client shows as in-progress and what refuses the next change to the group. A settings change carries per-field results, since WhatsApp can refuse one field and apply the others. A removal reports on the participant's own entry rather than here, so several can be in flight at once. Pinning is synchronous and reports nothing.

显示子属性
data.suspended_at
string

When WhatsApp suspended the group. Present only while the group is suspended, and gone once WhatsApp lifts the suspension.

data.created_at
string
必填
data.updated_at
string
必填
next_cursor
nullable string
必填

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

prev_cursor
nullable string
必填

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

refresh_cursor
nullable string
必填

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.

相关资源

继续查看此主题的文档、指南和示例。

获取实施简报