GET
/
v1
/
employees
curl --request GET \
  --url https://public-api.tryriot.com/v1/employees \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "country_code": "FR",
      "created_at": "2024-01-13T10:00:00.000000Z",
      "department": {
        "name": "Devs"
      },
      "email_addresses": [
        {
          "address": "[email protected]",
          "is_primary": true,
          "source": "google"
        }
      ],
      "id": "e4ebfd69-3c2c-4028-b423-1bff3d87d58f",
      "job_title": "Account manager",
      "karma": {
        "score": 500,
        "security_level": "dangerous"
      },
      "language": "english",
      "manager": {
        "id": "e4ebfd69-3c2c-4028-b423-1bff3d87d58f",
        "name": "John Doe",
        "primary_email_address": "[email protected]"
      },
      "name": "John Doe",
      "primary_email_address": "[email protected]",
      "status": "active",
      "timezone": "Europe/Paris",
      "updated_at": "2024-01-13T10:00:00.000000Z",
      "workspace": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-item-limit
integer
default:50

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

Required range: 1 <= x <= 100
​
x-next-cursor
string

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.

Query Parameters

​
workspace_id
string
required

ID of the workspace for which to retrieve employees

​
status
enum<string>[]

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.

Available options:
active,
deactivated,
pending
​
karma_score_gte
integer

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.

Required range: x >= 0
​
karma_score_lte
integer

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.

Required range: x >= 0

Response

200
application/json
Employees list
​
data
object[]
required