Groups
Team platform

List employees in a group

Retrieves a list of employees in a specific group, sorted by membership date in descending order (most recently added first). Returns an empty list if the group does not exist or has no employees.

Scopes required:

  • groups:read
get/v1/groups/{group_id}/employees

Request

  • Base URL: https://public-api.tryriot.com
  • URL: https://public-api.tryriot.com/v1/groups/{group_id}/employees
  • Auth: API key in header x-api-key

Path parameters

group_idstring uuid required

ID of the group

Query parameters

cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

limitinteger

Maximum number of items to return. Maximum value is 100.

workspace_idstring uuid required

ID of the workspace

Headers

x-item-limitinteger

Maximum number of items to return. Maximum value is 100.

x-next-cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

Response

Group employees list

Example response

{
  "data": [
    {
      "username": "john.doe"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.