people

List people

The directory: everyone this workspace can send a simulation to, with the status that decides whether it will. syncedProvider is set on anyone who came from a directory sync, and the fields that sync owns cannot be written through this API.

get/people

Request

  • Base URL: https://api.fallax.io/v1
  • URL: https://api.fallax.io/v1/people
  • Auth: HTTP bearer

Query parameters

limitstring

Rows per page, 1 to 200. Defaults to 50. A page comes back with a nextCursor when there are more.

Example:50
cursorstring

The nextCursor from the previous page. Paging is by cursor rather than by offset, so rows written while you page are never skipped.

sincestring

Only rows after this instant, exclusive. ISO 8601 or epoch milliseconds. This is the parameter a poll trigger uses: pass the timestamp of the newest row you have already handled.

Example:2026-09-07T12:00:00Z
order'desc' | 'asc'

desc (the default) for newest first, which is what a person reading a page wants. asc for oldest first, which is what anything resuming from a watermark wants: with since and a limit, an ascending page is the oldest rows you have not seen, so a backlog drains in order instead of the newest page hiding the rest.

status'active' | 'excluded' | 'archived'

active, excluded or archived.

emailstring

Exact address match.

departmentstring

Exact department match.

Response

List people

nextCursorstring nullable required

Pass as cursor for the next page.

hasMoreboolean required

Changes

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