Sign in

v1

latestOpenAPI 3.0.1Vanta Terms of Service2026-07-26327517821.8 KB
People

List people

Returns a list of all people.

get/people

Query parameters

pageSizeinteger

Controls the maximum number of items returned in one response from the API.

pageCursorstring

A marker or pointer, telling the API where to start fetching items for the subsequent page in a paginated dataset. Note that the requested page will not include the item that corresponds to this cursor but will start from the one immediately after this cursor.

tasksSummaryStatusMatchesAnyTasksSummaryStatus[]

Filter individuals by those whose tasksSummary status is any of the provided values.

taskTypeMatchesAnyTaskType[]

Requires taskStatusMatchesAny. Includes all people for whom any of the provided taskType values in taskTypeMatchesAny is any of the provided taskStatus values in taskStatusMatchesAny.

taskStatusMatchesAnyTaskStatus[]

Requires taskTypeMatchesAny. Includes all people for whom any of the provided taskType values in taskTypeMatchesAny is any of the provided taskStatus values in taskStatusMatchesAny.

emailAndNameFilterstring

Filter people by email address, first name, or last name (partial match, case-insensitive).

groupIdsMatchesAnystring[]

Filter people matching any of the given group IDs.

employmentStatus'UPCOMING' | 'CURRENT' | 'ON_LEAVE' | 'INACTIVE' | 'FORMER'

The employment status of a person:

  • UPCOMING: The person is not yet employed and will start employment in the future.
  • CURRENT: The person is currently employed.
  • ON_LEAVE: The person is on leave.
  • INACTIVE: The person's employment is inactive.
  • FORMER: The person was previously employed.

Filter people matching the given employment status.

Response

Ok