Skip to main content
List endpoints return results in pages. You control paging with the limit and page_token parameters.

How it works

Pass next_page_token in the next request to get the next page. An empty next_page_token means there are no more pages.
  • limit — defaults to 100, maximum 1000.
  • page_token — opaque. Do not parse or construct it; pass back exactly the value you received.
A token is bound to the filter set it was issued for. Passing it into a request with different status, department_id, updated_since, or limit returns INVALID_ARGUMENT. When you change filters, start paging again without a token.

Total count

By default the number of matching records is not counted. Request it explicitly with include_total=true:
A total_count field appears in the response. On large result sets (over ~10,000 records) this is a planner estimate, not an exact number.

Incremental sync

To pull only changes, filter by updated_since (RFC 3339):
updated_since reflects changes to the employee record itself. Renaming a related entity (person, department) does not show up in this field — use webhooks for those: a person rename arrives as employee.changed. To reconcile deletions, do a full re-read periodically.Encode a timezone offset in the query as %2B05:00, or send the time in Z (UTC): a + in a URL is otherwise read as a space.