Get a WhatsApp group

GET

/groups/{id}

curl --request GET \
  --url https://app.whatsetter.com/api/v1/groups/example \
  --header 'Authorization: Bearer <token>'

• Production

One tracked group with its WhatsApp community, AI reply mode, admin flag and sync state. id is the group’s id from /groups. Requires scope groups:read.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Responses

200

The group

Media typeapplication/json

object

data

object

id

string

whatsapp_id

string | null

name

string | null

description

string | null

participants_count

integer

messages_count

integer

status

string | null

Allowed values: active paused archived left

ai_enabled

boolean

invite_url

string | null

campaign_id

string | null

created_at

string format: date-time

is_admin

Whether the connected WhatsApp number is an admin of the group.

boolean

ai_reply_mode

string | null

Allowed values: mentions_only all_messages

intent

What the group is for (drives the dashboard’s audience defaults).

string | null

Allowed values: community webinar broadcast

community

WhatsApp Community the group belongs to, null for standalone groups.

object

id

string

name

string | null

role

announce = the community’s announcements group.

string | null

Allowed values: announce sub

sync_status

State of the message-history import.

string | null

Allowed values: idle pending syncing ready error

synced_at

string | null format: date-time

picture_url

Expiring WhatsApp CDN link to the group picture; null when absent or expired.

string | null

updated_at

string | null format: date-time

Example

{
  "data": {
    "status": "active",
    "ai_reply_mode": "mentions_only",
    "intent": "community",
    "community": {
      "role": "announce"
    },
    "sync_status": "idle"
  }
}

401

Missing, unknown or revoked API key

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Resource not found in this workspace

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}