Directories

List directory group members

Changed on

Returns the members of a group, as reported by the identity provider, using cursor-based pagination. Each member carries the Clerk user it is linked to, or null until that user has been provisioned.

get/directories/{directory_id}/groups/{group_id}/members

Request

  • Base URL
    https://api.clerk.com/v1
  • URL
    https://api.clerk.com/v1/directories/{directory_id}/groups/{group_id}/members
  • Auth
    HTTP bearer

Path parameters

directory_idstring required

The ID of the directory.

group_idstring required

The ID of the group, as assigned by the directory.

Query parameters

limitinteger

Applies a limit to the number of results returned. Can be used for paginating the results together with starting_after.

starting_afterstring

A cursor for pagination. Provide the starting_after cursor from a previous response to fetch the next page.

Response

A cursor-paginated list of the members of a group.

Changes