v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Groups

List all memberships in a group

🔑

Required OAuth scope: groups:read.

📖

This endpoint is paginated with a page size of 1,000 memberships. For more information, see the Pagination guide.

Lists all the memberships, sorted per user, of a specific group.

get/api/v2/groups/{groupId}/roles

Path parameters

groupIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the group.

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 1000 memberships.

userIdstring ObjectId required

The unique ID of the user.

role'admin' | 'analyst' | 'editor' | 'coach' | 'contributor' | 'learner' | 'owner' | 'userAdmin' required

The role of the group member.

Example response

[
  {
    "userId": "507f1f77bcf86cd799439011"
  }
]