Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Employees

List all employees

Returns a list of your employees. The employees are returned sorted by creation date, with the most recent employees appearing first.

get/employees

Query parameters

filterstring

Multiple values can be provided by separating them with a comma. Allowed values are: pending, active, offboarding, inactive, restricted.

employer_idstring
Example:er_3b1333d87d9d4fd6ad83ba7f6b0e951a

Filter by employer ID.

external_customer_idstring
metadata_idstring

Filter by the employee's metadata "id" value (case-insensitive, accent-insensitive, partial match)

pageinteger

The page of results to return. Defaults to 1 if not provided.

The page of results to return. Defaults to 1 if not provided.

page_sizeinteger

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK

pageinteger required

The current page of the results

page_sizeinteger required

The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size

total_countinteger required

The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.

has_next_pageboolean

Whether there are more pages available after this page

has_previous_pageboolean

Whether there are more pages available before this page

Example response

{
  "items": [
    {
      "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "date_of_birth": "2024-12-01",
      "start_on": "2024-12-01",
      "earliest_benefits_start_date": "2024-12-01",
      "offboard_on": "2024-12-01T00:00:00Z"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_count": 123,
  "has_next_page": true,
  "has_previous_page": true
}