Sign in

v1

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

List people for an audit

Retrieves people population data for an audit.

This endpoint provides access to the people records visible to auditors during an audit engagement. Only Controlled Audit View (CAV) audits are supported. Full Audit View audits are rejected with 403.

Supports filtering by:

  • search: Searches names and email addresses
  • status: Filters by employment status
  • groupsMatchesAny: Filter people by group/role IDs

Results are sorted by name (ascending) by default. Use orderBy and orderDirection to customize sorting. Sort parameters must remain consistent across paginated requests.

Uses cursor-based pagination. To paginate:

  1. Make initial request with desired pageSize
  2. Check results.pageInfo.hasNextPage
  3. Use results.pageInfo.endCursor as pageCursor for next request

Rate limit: 10 requests / minute.

get/audits/{auditId}/personnel/people

Path parameters

auditIdstring required

The audit ID

Query parameters

pageSizeinteger

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

Maximum number of results per page (1-100, default 10)

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.

Pagination cursor from previous response

searchstring

Search term for filtering by name or email

status'CURRENTLY_EMPLOYED' | 'INACTIVE_EMPLOYEE' | 'NOT_PEOPLE' | 'ON_LEAVE' | 'PREVIOUSLY_EMPLOYED' | 'UPCOMING_EMPLOYEE'

Employment status filter for people queries.

Employment status filter

groupsMatchesAnystring[]

Filter people by group IDs

orderBy'name' | 'employmentStatus'

Field to sort results by. Allowed: "name", "employmentStatus". Default: "name"

orderDirection'asc' | 'desc'

"asc" for ascending, "desc" for descending.

Sort direction: "asc" or "desc". Default: "asc"

Response

Paginated list of people with pagination metadata

Example response

{
  "results": {
    "data": [
      {
        "id": "5f2c939a52855e725c8d5824",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "jobTitle": "Software Engineer",
        "startDate": "2021-01-15",
        "endDate": "2021-01-15",
        "groups": [
          {
            "name": "Engineering"
          },
          {
            "name": "Admin"
          }
        ],
        "source": {
          "mainSource": "Okta",
          "supplementarySource": "Google Workspace"
        },
        "taskStatus": {
          "dueDate": "2024-03-15",
          "completionDate": "2024-01-20",
          "numTasksCompleted": 5,
          "numTasksOverdue": 2,
          "numTasksDueSoon": 1
        },
        "lastReminded": "2024-01-15",
        "policies": {
          "dueDate": "2024-03-15",
          "completionDate": "2024-01-20"
        },
        "trainings": {
          "dueDate": "2024-03-15",
          "completionDate": "2024-01-20"
        },
        "backgroundChecks": {
          "dueDate": "2024-03-15",
          "completionDate": "2024-01-20"
        },
        "deviceMonitoring": {
          "dueDate": "2024-03-15",
          "completionDate": "2024-01-20"
        },
        "customOnboarding": {
          "dueDate": "2024-03-15",
          "completionDate": "2024-01-20"
        },
        "customOffboarding": {
          "dueDate": "2024-03-15",
          "completionDate": "2024-01-20"
        }
      }
    ]
  }
}