--- title: "List people" method: GET path: "/people" tags: ["People"] --- # List people `GET /people` Returns a list of all people. ## Query parameters - `pageSize` integer — 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` TasksSummaryStatus[] - `taskTypeMatchesAny` TaskType[] - `taskStatusMatchesAny` TaskStatus[] - `emailAndNameFilter` string - `groupIdsMatchesAny` string[] - `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. ## Response `200` Ok - PaginatedResponsePerson - `results` object, required - `data` Person[], required - `id` string, required - `userId` string, nullable, required — The ID of the Vanta user account associated with this person, if one exists. - `emailAddress` string, required - `employment` object, required - `status` 'UPCOMING' | 'CURRENT' | 'ON_LEAVE' | 'INACTIVE' | 'FORMER', required — 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. - `startDate` string, date-time, required — The date the person's employment started. - `jobTitle` string, nullable, required — The person's job title. - `endDate` string, date-time, nullable, required — If present, the date the person's employment ended. - `leaveInfo` LeaveInfo, required - `startDate` string, date-time, required — The start of the person's leave. - `endDate` string, date-time, nullable, required — The end of the person's leave. Null endDate implies indefinite leave. - `status` 'ACTIVE' | 'UPCOMING', required — User can be active or upcoming leave period - `groupIds` string[], required — The id of each group the user belongs to. This includes both manually created groups in Vanta and groups imported from an identity provider. - `name` object, required - `first` string, nullable, required — The person's first (given) name. - `last` string, nullable, required — The person's last (family) name. - `display` string, required — The person's display name, used in Vanta. - `sources` object, required — The sources of the person's information. - `employment` object, required - `endDate` union, required — The source of the person's information. - VantaBasedPersonInfoSource — The person's information comes from what is set in Vanta. - … - ScimBasedPersonInfoSource — The person's information comes from SCIM. - … - IntegrationBasedPersonInfoSource — The person's information comes from an integration. - … - `startDate` union, required — The source of the person's information. - VantaBasedPersonInfoSource — The person's information comes from what is set in Vanta. - … - ScimBasedPersonInfoSource — The person's information comes from SCIM. - … - IntegrationBasedPersonInfoSource — The person's information comes from an integration. - … - `emailAddress` union, required — The source of the person's information. - VantaBasedPersonInfoSource — The person's information comes from what is set in Vanta. - `type` 'VANTA', required - ScimBasedPersonInfoSource — The person's information comes from SCIM. - `type` 'SCIM', required - IntegrationBasedPersonInfoSource — The person's information comes from an integration. - `integrationId` string, required - `resourceId` string, nullable, required - `type` 'INTEGRATION', required - `tasksSummary` object, required — The person's tasks summary, which aggregates their current status across all of their relevant tasks. - `details` TaskSummaryDetails, required — All detailed information about a person's tasks, split across task categories. - `completeTrainings` CompleteTrainingsTaskSummary, required — Task summary for completing all trainings. - `taskType` 'COMPLETE_TRAININGS', required - `status` 'COMPLETE' | 'DUE_SOON' | 'OVERDUE' | 'NONE', required — The status of a task. - COMPLETE: The task has been completed. - DUE_SOON: The task is due soon. - OVERDUE: The task is overdue. - NONE: The task is not assigned. - `dueDate` string, date-time, nullable, required — The due date of the task. - `completionDate` string, date-time, nullable, required — The date the task was completed. - `disabled` object, nullable, required — If the task is disabled, the reason and date when it was disabled. - … - `incompleteTrainings` Training[], required — Incomplete security trainings that are relevant given a person's requirements. - … - `completedTrainings` Training[], required — Security trainings that have been completed and are relevant given a person's current requirements. - … - `acceptPolicies` AcceptPoliciesTaskSummary, required — Policy acceptance details for a person. - `taskType` 'ACCEPT_POLICIES', required - `status` 'COMPLETE' | 'DUE_SOON' | 'OVERDUE' | 'NONE', required — The status of a task. - COMPLETE: The task has been completed. - DUE_SOON: The task is due soon. - OVERDUE: The task is overdue. - NONE: The task is not assigned. - `dueDate` string, date-time, nullable, required — The due date of the task. - `completionDate` string, date-time, nullable, required — The date the task was completed. - `disabled` object, nullable, required — If the task is disabled, the reason and date when it was disabled. - … - `unacceptedPolicies` object[], required — Unaccepted policies that are relevant to the person. - … - `acceptedPolicies` object[], required — Accepted policies that are relevant to the person. - … - `completeCustomTasks` CompleteCustomTasksTaskSummary, required — Task summary for completing all custom tasks. - `taskType` 'COMPLETE_CUSTOM_TASKS', required - `status` 'COMPLETE' | 'DUE_SOON' | 'OVERDUE' | 'NONE', required — The status of a task. - COMPLETE: The task has been completed. - DUE_SOON: The task is due soon. - OVERDUE: The task is overdue. - NONE: The task is not assigned. - `dueDate` string, date-time, nullable, required — The due date of the task. - `completionDate` string, date-time, nullable, required — The date the task was completed. - `disabled` object, nullable, required — If the task is disabled, the reason and date when it was disabled. - … - `incompleteCustomTasks` CustomTask[], required — Incomplete custom tasks that are relevant given a person's requirements. - … - `completedCustomTasks` CustomTask[], required — Custom tasks that have been completed and are relevant given a person's current requirements. - … - `completeOffboardingCustomTasks` CompleteOffboardingCustomTasksTaskSummary, required — Task summary for completing all offboarding custom tasks. - `taskType` 'COMPLETE_CUSTOM_OFFBOARDING_TASKS', required - `status` 'COMPLETE' | 'DUE_SOON' | 'OVERDUE' | 'NONE', required — The status of a task. - COMPLETE: The task has been completed. - DUE_SOON: The task is due soon. - OVERDUE: The task is overdue. - NONE: The task is not assigned. - `dueDate` string, date-time, nullable, required — The due date of the task. - `completionDate` string, date-time, nullable, required — The date the task was completed. - `disabled` object, nullable, required — If the task is disabled, the reason and date when it was disabled. - … - `incompleteCustomOffboardingTasks` CustomTask[], required — Incomplete custom tasks that are relevant given a person's requirements. - … - `completedCustomOffboardingTasks` CustomTask[], required — Custom tasks that have been completed and are relevant given a person's current requirements. - … - `installDeviceMonitoring` InstallDeviceMonitoringTaskSummary, required — Task summary for installing device monitoring. - `taskType` 'INSTALL_DEVICE_MONITORING', required - `status` 'COMPLETE' | 'DUE_SOON' | 'OVERDUE' | 'NONE', required — The status of a task. - COMPLETE: The task has been completed. - DUE_SOON: The task is due soon. - OVERDUE: The task is overdue. - NONE: The task is not assigned. - `dueDate` string, date-time, nullable, required — The due date of the task. - `completionDate` string, date-time, nullable, required — The date the task was completed. - `disabled` object, nullable, required — If the task is disabled, the reason and date when it was disabled. - … - `completeBackgroundChecks` CompleteBackgroundChecksTaskSummary, required — Task summary for completing background checks. - `taskType` 'COMPLETE_BACKGROUND_CHECKS', required - `status` 'COMPLETE' | 'DUE_SOON' | 'OVERDUE' | 'NONE', required — The status of a task. - COMPLETE: The task has been completed. - DUE_SOON: The task is due soon. - OVERDUE: The task is overdue. - NONE: The task is not assigned. - `dueDate` string, date-time, nullable, required — The due date of the task. - `completionDate` string, date-time, nullable, required — The date the task was completed. - `disabled` object, nullable, required — If the task is disabled, the reason and date when it was disabled. - … - `status` 'COMPLETE' | 'DUE_SOON' | 'NONE' | 'OFFBOARDING_COMPLETE' | 'OFFBOARDING_DUE_SOON' | 'OFFBOARDING_OVERDUE' | 'OVERDUE' | 'PAUSED', required — The overall status of a person's outstanding tasks: - NONE: There are no tasks. - DUE_SOON: At least one task is due soon. - OVERDUE: At least one task is overdue. Has a higher priority than DUE_SOON. - COMPLETE: All tasks are complete. - PAUSED: All tasks are paused. - OFFBOARDING_DUE_SOON: At least one offboarding task is due soon. - OFFBOARDING_OVERDUE: At least one offboarding task is overdue. Has a higher priority than OFFBOARDING_DUE_SOON. - OFFBOARDING_COMPLETE: All offboarding tasks are complete. - `dueDate` string, date-time, nullable, required — The due date of the person's earliest-due task. - `completionDate` string, date-time, nullable, required — The date when person's tasks were completed. - `pageInfo` PageInfo, required — Provides information about the pagination of a dataset. - `endCursor` string, nullable, required — The cursor that points to the end of the current page, or null if there is no such cursor. - `hasNextPage` boolean, required — Indicates if there is another page after the current page. - `hasPreviousPage` boolean, required — Indicates if there is a page before the current page. - `startCursor` string, nullable, required — The cursor that points to the start of the current page, or null if there is no such cursor. --- [API](https://skmtc.net/vanta/apis/build-integrations.md) · [All operations](https://skmtc.net/vanta/apis/build-integrations/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vanta/build-integrations/versions/6c1f7590538b/schema)