List group join / leave events

GET

/groups/{id}/events

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

• Production

Membership audit log of one group (joins and leaves), newest first, as observed from live WhatsApp events and sync passes. Filter by type, since, until. Requires scope groups:read.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Query Parameters

type

string

Allowed values: join leave

since

string format: date-time

ISO-8601 — only events at or after this instant.

until

string format: date-time

ISO-8601 — only events at or before this instant.

limit

integer

default: 25 >= 1 <= 100

cursor

string

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

Responses

200

Page of events

Media typeapplication/json

object

data

Array<object>

object

id

string

type

string

Allowed values: join leave

phone

The member who joined or left (international digits).

string | null

name

Display name, when the member is known.

string | null

occurred_at

string | null format: date-time

source

How the event was observed.

string | null

Allowed values: event sync_detected backfill webhook_replay

actor_phone

Admin who added / removed the member, when WhatsApp reported one.

string | null

pagination

object

has_more

boolean

next_cursor

string | null

Example

{
  "data": [
    {
      "type": "join",
      "source": "event"
    }
  ]
}

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