List groups for an audit
Retrieves groups population data for an audit.
This endpoint provides access to the group records visible to auditors during an audit engagement. Groups represent organizational units that contain people, either imported from an identity provider (IDP) or created manually in Vanta.
Only Controlled Audit View (CAV) audits are supported. Full Audit View audits are rejected with 403.
Supports filtering by:
- search: Searches group names (case-insensitive)
- sourcesMatchesAny: Filters by IDP source service names
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:
- Make initial request with desired pageSize
- Check results.pageInfo.hasNextPage
- Use results.pageInfo.endCursor as pageCursor for next request
Rate limit: 10 requests / minute.
Path parameters
The audit ID
Query parameters
Controls the maximum number of items returned in one response from the API.
Maximum number of results per page (1-100, default 10)
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
Search term for filtering by group name
Filter groups by IDP source service names
Field to sort results by. Allowed: "name", "members", "source", "tasksLastUpdated", "pointOfContact". Default: "name"
"asc" for ascending, "desc" for descending.
Sort direction: "asc" or "desc". Default: "asc"
Response
Paginated list of groups with pagination metadata
Example response
{
"results": {
"data": [
{
"id": "5f2c939a52855e725c8d5824",
"name": "Engineering",
"members": 42,
"source": "Okta",
"tasks": [
{
"name": "Security Training"
},
{
"name": "Policy Acceptance"
}
],
"tasksLastUpdated": "2024-06-15T10:30:00.000Z",
"pointOfContact": "Jane Doe"
}
]
}
}