List group members

GET

/groups/{id}/members

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

• Production

Participants of one group (phone, display name, role, whether they are still in the group), most recently added first. Filter status=active or status=left. Requires scope groups:read.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Query Parameters

status

string

Allowed values: active left

limit

integer

default: 25 >= 1 <= 100

cursor

string

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

Responses

200

Page of members

Media typeapplication/json

object

data

Array<object>

object

id

string

phone

International digits, e.g. 33612345678.

string | null

name

WhatsApp display name, when known.

string | null

role

string

Allowed values: superadmin admin member

status

left once the member is no longer in the group.

string

Allowed values: active left

joined_at

string | null format: date-time

left_at

string | null format: date-time

joined_source

How the join date was established (e.g. initial_sync, event).

string | null

messages_count

integer

pagination

object

has_more

boolean

next_cursor

string | null

Example

{
  "data": [
    {
      "role": "superadmin",
      "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"
  }
}

404

Resource not found in this workspace

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"
  }
}