Dokumentacja
Sign inGet started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

Get a WhatsApp group

GET
/v1/whatsapp/groups/{group_id}
const group = await bird.whatsapp.groups.get("wag_01krdgeqcxet5s7t44vh8rt9mg");
console.log(group.status, group.invite_link);
Odpowiedź200
{
  "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": "BR.1566655121691972",
      "phone_number": "+16505551234",
      "username": "jim.almeida",
      "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"
        }
      }
    }
  ],
  "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"
}
Returns one group as it currently stands, including who is in it. The business number that administers the group is not counted among the participants.
Read the group back after creating it to watch status move from pending to active, which is when WhatsApp has issued the invite_link. A suspended group is one WhatsApp has stopped activity in; a deleted one is kept here so a reference to it still resolves.
Parametry
group_id
string
ID of the group, as returned when it was created.
Treść odpowiedzi
id
string
wymagane
Unique identifier for the group. Accepted by every /v1/whatsapp/groups/{group_id} operation, and as to when sending a message to the group.
whatsapp_number_id
string
wymagane
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.
waba
nullable string
wymagane
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.
subject
string
wymagane
The group's name, shown to participants and to anyone who opens the invite link.
description
nullable string
The group's description, shown alongside the subject. Null when the group has none.
status
string
wymagane
Where the group stands. A group is messageable only while it is active.
join_approval_mode
string
wymagane
Whether opening the invite link joins the group outright or raises a join request to approve.
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.
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.
Pokaż atrybuty podrzędne
participants.bsuid
string
wymagane
Business-scoped user ID, Meta's identifier for this person against your business. The one identifier every participant has: WhatsApp always sends it, and it is stable for as long as they are in the group.
participants.phone_number
string
Phone number in E.164 format. Absent when WhatsApp withholds it, which it does for anyone who has not shared their number with your business, so a group is normally a mix of participants with one and without.
participants.username
string
The WhatsApp username this person chose. Absent when they have none, and not an identifier to address them by: it is theirs to change, so it names them in a list rather than keying anything.
participants.last_operation
object
A removal asked of this participant that has not taken effect: pending while WhatsApp has yet to confirm it, or failed when WhatsApp refused. Never success, because a removal that succeeds takes the participant off this list: the entry disappearing is what says it worked. A pending removal refuses a second removal of the same person while leaving other participants free to be removed at the same time.
Pokaż atrybuty podrzędne
participants.last_operation.type
string
wymagane
What was asked.
participants.last_operation.status
string
wymagane
Where it got to. pending is what a client shows as in-progress, and what refuses the next change.
participants.last_operation.requested_at
string
wymagane
When Bird accepted the request.
participants.last_operation.settled_at
nullable string
When WhatsApp reported the outcome. Null while pending.
participants.last_operation.results
array of object
Per-field outcomes, on a settings_update that has settled. One entry per field the update carried, so a client can put a refusal next to the input it came from. Absent on every other operation type, which change one thing and report it on status.
Pokaż atrybuty podrzędne
participants.last_operation.results.field
string
wymagane
The setting this result reports on.
participants.last_operation.results.applied
boolean
wymagane
Whether WhatsApp applied this field. False when it refused this one, whatever it did with the others.
participants.last_operation.results.error
object
Why WhatsApp refused this field. Present only when applied is false.
Pokaż atrybuty podrzędne
participants.last_operation.results.error.description
string
wymagane
WhatsApp's own explanation of the refusal, passed through. Show it to the person who asked for the change; never match on its text. Carries Bird's own words instead when the failure was Bird's verdict, such as a confirmation that never arrived.
participants.last_operation.results.error.meta_error_code
nullable string
WhatsApp's most specific code for the refusal: its error subcode where it sent one, otherwise its top-level code. Treat it as an opaque string. Null when the failure was Bird's own verdict rather than a WhatsApp refusal.
participants.last_operation.last_error
object
Why the operation failed as a whole. Present when status is failed, including when the confirmation never arrived and Bird gave up waiting. A settings_update that failed on some fields and not others carries the per-field detail in results.
Pokaż atrybuty podrzędne
participants.last_operation.last_error.description
string
wymagane
WhatsApp's own explanation of the refusal, passed through. Show it to the person who asked for the change; never match on its text. Carries Bird's own words instead when the failure was Bird's verdict, such as a confirmation that never arrived.
participants.last_operation.last_error.meta_error_code
nullable string
WhatsApp's most specific code for the refusal: its error subcode where it sent one, otherwise its top-level code. Treat it as an opaque string. Null when the failure was Bird's own verdict rather than a WhatsApp refusal.
participant_count
integer
wymagane
How many people are in the group, excluding your business.
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.
Pokaż atrybuty podrzędne
pinned_messages.message_id
string
wymagane
The pinned message, as returned in the send response's id.
pinned_messages.pinned_until
string
wymagane
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.
profile_picture_url
nullable string
Address of the group's picture, as WhatsApp serves it. Null when the group has none.
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.
Pokaż atrybuty podrzędne
last_operation.type
string
wymagane
What was asked.
last_operation.status
string
wymagane
Where it got to. pending is what a client shows as in-progress, and what refuses the next change.
last_operation.requested_at
string
wymagane
When Bird accepted the request.
last_operation.settled_at
nullable string
When WhatsApp reported the outcome. Null while pending.
last_operation.results
array of object
Per-field outcomes, on a settings_update that has settled. One entry per field the update carried, so a client can put a refusal next to the input it came from. Absent on every other operation type, which change one thing and report it on status.
Pokaż atrybuty podrzędne
last_operation.results.field
string
wymagane
The setting this result reports on.
last_operation.results.applied
boolean
wymagane
Whether WhatsApp applied this field. False when it refused this one, whatever it did with the others.
last_operation.results.error
object
Why WhatsApp refused this field. Present only when applied is false.
Pokaż atrybuty podrzędne
last_operation.results.error.description
string
wymagane
WhatsApp's own explanation of the refusal, passed through. Show it to the person who asked for the change; never match on its text. Carries Bird's own words instead when the failure was Bird's verdict, such as a confirmation that never arrived.
last_operation.results.error.meta_error_code
nullable string
WhatsApp's most specific code for the refusal: its error subcode where it sent one, otherwise its top-level code. Treat it as an opaque string. Null when the failure was Bird's own verdict rather than a WhatsApp refusal.
last_operation.last_error
object
Why the operation failed as a whole. Present when status is failed, including when the confirmation never arrived and Bird gave up waiting. A settings_update that failed on some fields and not others carries the per-field detail in results.
Pokaż atrybuty podrzędne
last_operation.last_error.description
string
wymagane
WhatsApp's own explanation of the refusal, passed through. Show it to the person who asked for the change; never match on its text. Carries Bird's own words instead when the failure was Bird's verdict, such as a confirmation that never arrived.
last_operation.last_error.meta_error_code
nullable string
WhatsApp's most specific code for the refusal: its error subcode where it sent one, otherwise its top-level code. Treat it as an opaque string. Null when the failure was Bird's own verdict rather than a WhatsApp refusal.
suspended_at
string
When WhatsApp suspended the group. Present only while the group is suspended, and gone once WhatsApp lifts the suspension.
created_at
string
wymagane
updated_at
string
wymagane

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Zrozum koncepcjęShould I use a Bird SDK or call the API directly?Podążaj ścieżką naukiBuild your first integrationPrzewodnik wdrożeniowySend your first email
Uzyskaj brief wdrożeniowy