General
Team platform

List employees

Retrieves a list of workspace employees, sorted by their creation date in descending order (most recent entries first).

Scopes required:

  • workspace:read
get/v1/employees

Request

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

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 for which to retrieve employees

statusEmployeeStatusSchema[]

Filters employees based on their status. Accepts a comma-separated string of status values. Only employees matching the specified statuses will be included in the response.

karma_score_gteinteger

Filters employees based on their karma score. Only employees with a score greater than or equal to the specified value will be included in the response.

karma_score_lteinteger

Filters employees based on their karma score. Only employees with a score less than or equal to the specified value will be included in the response.

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

Employees list

Example response

{
  "data": [
    {
      "country_code": "FR",
      "cyber_posture": {
        "score_percentage": 87.5
      },
      "department": {
        "name": "Devs"
      },
      "email_addresses": [
        {
          "address": "john.doe@tryriot.com",
          "source": "google"
        }
      ],
      "google_user_id": "112233445566778899000",
      "job_title": "Account manager",
      "language": "english",
      "manager": {
        "name": "John Doe",
        "primary_email_address": "john.doe@tryriot.com"
      },
      "microsoft_user_id": "f9a7ceeb-6c82-48b1-a522-faf335c7d623",
      "name": "John Doe",
      "okta_user_id": "00u1abcdef2GhIjKlMn3",
      "primary_email_address": "john.doe@tryriot.com",
      "slack_user_id": "U01234ABCDE",
      "timezone": "Europe/Paris"
    }
  ]
}

Changes

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