Skip to main content
GET
/
v1
/
groups
/
{id}
/
members
List group members
curl --request GET \
  --url https://api.scrip.dev/v1/groups/{id}/members \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "external_id": "user_123",
      "joined_at": "2024-01-15T10:30:00Z",
      "left_at": "2024-02-15T10:30:00Z",
      "participant_id": "550e8400-e29b-41d4-a716-446655440000",
      "role": "MEMBER",
      "status": "ACTIVE"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
Returns the members of a group, including each member’s participant ID, role (ADMIN or MEMBER), and status. Results are paginated. Former members who have been removed are assigned a LEFT status and are excluded from the response by default. To include them, pass include_former=true. This is useful for audit trails or understanding group membership history.
For usage patterns and examples, see the Groups guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
id
string<uuid>
required

Group ID

Query Parameters

​
limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
​
cursor
string

Pagination cursor from previous response

​
include_former
boolean
default:false

Include former members (LEFT)

Response

List of group members

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results