Skip to main content
Filters are query parameters on a list endpoint. They narrow the result set, and combine with expand, modified_after, cursor and page_size in a single request. The examples here use Get Employees, but the same behavior applies across HRIS, Payroll, ATS and LMS endpoints. The exact filter set differs per model, so check the reference page for the endpoint you are calling.

​
How filters work

  • Multiple filters combine with AND. employment_status=ACTIVE&company_id=<id> returns active employees at that company only.
  • ID parameters accept comma-separated lists, which behave as OR within that parameter. Do not put spaces after the commas.
  • Name and email filters are case-insensitive.
  • Filters are inclusive only. Fetch the values you want rather than the ones you don’t.
  • Filtering happens before pagination. Page through a filtered result set with cursor exactly as you would an unfiltered one.

​
Employee filters

Get Employees lists every supported filter, generated from the API spec. Two more parameters shape the payload rather than the result set. Both default to false:
Custom fields are returned, never filtered on.
- marks a record the source gave no status for, so filtering for any specific status excludes those records. For connector-specific status values, see Enum values.

​
Filters on the other HRIS endpoints

ids, remote_id, modified_after, page_size and cursor work everywhere. These are the ones specific to each endpoint: Employment and compensation records belong to an employee, so you read them from their own endpoint and filter on employee_id. Reading the whole collection once and grouping by employee costs far fewer calls than looping per person - see Rate limits.

​
Examples

Active employees at one company:
Fetch a specific set of employees by ID in one call:
Look up an employee you only know by their identifier in the source system:
If that last one returns nothing, check the value against raw_data before assuming the filter is broken. Many HRIS platforms display one identifier on screen and return another through their API. For which identifier to store, see id vs remote_id.

Reading data

How filters combine with expand, modified_after and pagination.

Expand

Return related objects inline instead of just their IDs.

Enum values

Why employment_status and other enums are not a closed set.

Record identity

When to filter on id versus remote_id.