Skip to content

List members groups

GET /api/v1/groups/{groupId}/members: request fields and declared response contract.

GET/api/v1/groups/{groupId}/members

Authorization
Permissiongroup.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
groupIdstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.membersarrayrequirednon-null—
data.totalintegerrequirednon-null—

Declared failures

Declared failures
GROUPS_GET_MEMBERS_FAILED500 — not retryable

Readback

This method returns the current state it read.

  • groups.getMembers

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/groups/{groupId}/members HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>