Skip to main content
List all users with optional filtering.
External DocumentationTo learn more, visit the Vanta documentation.

Basic Parameters

ParameterDescription
Page CursorA cursor that marks the starting point for fetching the next page of results. Use the endCursor value from the pageInfo object in the previous response.
Page SizeThe maximum number of items returned in a single execution.
Return All PagesAutomatically fetch all resources, page by page.

Advanced Parameters

ParameterDescription
Task StatusFilter users by the statuses of their tasks.
Task Summary StatusFilter users by the summary statuses of their tasks.
Task TypeFilter users by the types of their tasks.

Example Output

{
	"results": {
		"data": [
			{
				"id": "65e1efde08e8478f143a8ff9",
				"emailAddress": "example-person@email.com",
				"employment": {
					"endDate": null,
					"jobTitle": "Customer success manager",
					"startDate": "2021-01-01T00:00:00.000Z",
					"status": "CURRENT"
				},
				"leaveInfo": null,
				"groupIds": [
					"5f2c939a52855e725c8d5824"
				],
				"name": {
					"display": "Example Person",
					"last": "Person",
					"first": "Example"
				},
				"sources": {
					"emailAddress": {
						"integrationId": "gsuiteadmin",
						"resourceId": "660c701d3d344e660b032306",
						"type": "INTEGRATION"
					},
					"employment": {
						"startDate": {
							"integrationId": "gusto",
							"resourceId": "660c70783d344e660b032323",
							"type": "INTEGRATION"
						},
						"endDate": {
							"integrationId": "gusto",
							"resourceId": "660c70783d344e660b032323",
							"type": "INTEGRATION"
						}
					}
				},
				"tasksSummary": {
					"completionDate": null,
					"dueDate": "2021-12-01T00:00:00.000Z",
					"status": "OVERDUE",
					"details": {
						"completeTrainings": {
							"taskType": "COMPLETE_TRAININGS",
							"status": "COMPLETE",
							"dueDate": "2021-12-01T00:00:00.000Z",
							"completionDate": "2021-11-01T00:00:00.000Z",
							"disabled": {
								"date": "2021-11-01T00:00:00.000Z",
								"reason": "Training Vanta tests have been disabled for this person"
							},
							"incompleteTrainings": [
								{
									"name": "Security training 1"
								},
								{
									"name": "Security training 2"
								}
							],
							"completedTrainings": [
								{
									"name": "Security training 3"
								},
								{
									"name": "Security training 4"
								}
							]
						},
						"acceptPolicies": {
							"taskType": "ACCEPT_POLICIES",
							"status": "COMPLETE",
							"dueDate": "2021-12-01T00:00:00.000Z",
							"completionDate": "2021-11-01T00:00:00.000Z",
							"disabled": null,
							"unacceptedPolicies": [
								{
									"name": "Policy 1"
								},
								{
									"name": "Policy 2"
								}
							],
							"acceptedPolicies": [
								{
									"name": "Policy 3"
								},
								{
									"name": "Policy 4"
								}
							]
						},
						"completeCustomTasks": {
							"taskType": "COMPLETE_CUSTOM_TASKS",
							"status": "OVERDUE",
							"dueDate": "2021-12-01T00:00:00.000Z",
							"completionDate": "2021-11-01T00:00:00.000Z",
							"disabled": {
								"date": "2021-11-01T00:00:00.000Z",
								"reason": "Custom task Vanta tests have been disabled for this person"
							},
							"incompleteCustomTasks": [
								{
									"name": "Custom task 1"
								},
								{
									"name": "Custom task 2"
								}
							],
							"completedCustomTasks": [
								{
									"name": "Custom task 3"
								},
								{
									"name": "Custom task 4"
								}
							]
						},
						"completeOffboardingCustomTasks": {
							"taskType": "COMPLETE_CUSTOM_OFFBOARDING_TASKS",
							"status": "COMPLETE",
							"dueDate": "2021-12-01T00:00:00.000Z",
							"completionDate": "2021-11-01T00:00:00.000Z",
							"disabled": null,
							"incompleteCustomOffboardingTasks": [],
							"completedCustomOffboardingTasks": [
								{
									"name": "Custom offboarding task 1"
								},
								{
									"name": "Custom offboarding task 2"
								}
							]
						},
						"installDeviceMonitoring": {
							"taskType": "INSTALL_DEVICE_MONITORING",
							"status": "DUE_SOON",
							"dueDate": "2021-12-01T00:00:00.000Z",
							"completionDate": null,
							"disabled": null
						},
						"completeBackgroundChecks": {
							"taskType": "COMPLETE_BACKGROUND_CHECKS",
							"status": "COMPLETE",
							"dueDate": "2021-12-01T00:00:00.000Z",
							"completionDate": "2021-11-01T00:00:00.000Z",
							"disabled": null
						}
					}
				}
			}
		],
		"pageInfo": {
			"hasNextPage": false,
			"hasPreviousPage": false,
			"startCursor": "65e1efde08e8478f143a8ff9",
			"endCursor": "65e1efde08e8478f143a8ff9"
		}
	}
}

Workflow Library Example

List Users with Vanta and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop