List WhatsApp groups

GET

/groups

curl --request GET \
  --url 'https://app.whatsetter.com/api/v1/groups?status=active&limit=25' \
  --header 'Authorization: Bearer <token>'

• Production

The workspace’s tracked WhatsApp groups (name, size, invite link, AI state), newest first. Filter by status or by WhatsApp community_id. Requires scope groups:read.

Authorizations

• bearerAuth

Parameters

Query Parameters

status

string

Allowed values: active paused archived left

community_id

string

Only groups that belong to this WhatsApp Community (community.id of a group).

limit

integer

default: 25 >= 1 <= 100

cursor

string

Opaque cursor from the previous page’s pagination.next_cursor.

Responses

200

Page of groups

Media typeapplication/json

object

data

Array<object>

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

pagination

object

has_more

boolean

next_cursor

string | null

Example

{
  "data": [
    {
      "status": "active"
    }
  ]
}

401

Missing, unknown or revoked API key

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

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

422

Invalid parameter or body (also an invalid or expired cursor)

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

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