List people

get

https://api.vanta.com/v1/people

Returns a list of all people.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageSize

int32

1 to 100

Defaults to 10

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

pageCursor

string

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.

tasksSummaryStatusMatchesAny

array of objects

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

tasksSummaryStatusMatchesAny

taskTypeMatchesAny

array of objects

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

taskTypeMatchesAny

taskStatusMatchesAny

array of objects

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

taskStatusMatchesAny

emailAndNameFilter

string

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

groupIdsMatchesAny

array of strings

Filter people matching any of the given group IDs.

groupIdsMatchesAny

employmentStatus

string

enum

Filter people matching the given employment status.

Allowed:

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok