Vanta
App · 25 actions
Read your Vanta compliance program, personnel, tests, vendors and event logs, and manage groups.
Actions
| Action | What it does |
|---|---|
| Create group | Create a group. |
| Delete group | Delete a group by ID. |
| Get control | Get a control by an ID. |
| Get document | Get a document by ID. |
| Get framework | Get a framework by ID. |
| Get group | Get a group by ID. |
| Get organization | Get the organization selected by the authenticated token. |
| Get person | Get a person by ID. |
| Get policy | Get a policy by ID. |
| Get test | Get a test by ID. |
| Get vendor | Get a vendor. |
| List control documents | List a control's documents. |
| List control tests | List a control's tests. |
| List controls | List controls. |
| List document uploads | List the uploaded files for a document. |
| List documents | List documents. |
| List event logs | List event logs. |
| List framework controls | List a framework's controls. |
| List frameworks | List frameworks in your program, or every available framework. |
| List groups | List all groups by ID. |
| List people | Get a list of all people. |
| List policies | List all policies. |
| List tests | List all tests based on applied filters. |
| List vendors | List of vendors. |
| Update group | Partially updates a group. |
Create group
Create a group.
Inputs
- Point of contact email
point_of_contact_emailtext - Email address of the group's point of contact. Must be an active administrator.
- Description
descriptiontext - Description of the group.
- Name
nametextRequired - Display name for the group. Must not duplicate an existing group's name.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"creationDate": null,
"description": null,
"id": "example",
"name": "example",
"personnelCount": 0,
"pointOfContact": null,
"source": "example"
},
"has_more": false,
"next_cursor": null
}Delete group
Delete a group by ID.
Inputs
- Group
group_idtextRequired - Group id.
Outputs
Result.
datanull- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": null,
"has_more": false,
"next_cursor": null
}Get control
Get a control by an ID.
Inputs
- Control
control_idtextRequired - Control id.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"creationDate": null,
"customFields": [],
"description": "example",
"domains": [],
"externalId": null,
"id": "example",
"implementationDetails": null,
"modificationDate": null,
"name": "example",
"note": null,
"numDocumentsPassing": 0,
"numDocumentsTotal": 0,
"numTestsPassing": 0,
"numTestsTotal": 0,
"owner": null,
"role": null,
"source": "example",
"status": "example"
},
"has_more": false,
"next_cursor": null
}Get document
Get a document by ID.
Inputs
- Document
document_idtextRequired - Document id.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"category": "example",
"deactivatedStatus": {
"creationDate": "example",
"expiration": null,
"isDeactivated": false,
"reason": null
},
"description": "example",
"id": "example",
"isSensitive": false,
"nextRenewalDate": null,
"note": null,
"ownerId": null,
"reminderWindow": null,
"renewalCadence": "example",
"subscribers": [],
"title": "example",
"uploadStatus": "example",
"uploadStatusDate": null,
"url": null
},
"has_more": false,
"next_cursor": null
}Get framework
Get a framework by ID.
Inputs
- Framework
framework_idtextRequired - Framework id.
- Include status
include_statustrue/false - Whether to include lifecycle status. Defaults to true.
- Include requirements
include_requirementstrue/false - Whether to include the flat requirements list. Defaults to false.
- Requirements scope
requirements_scopetext - Used with includeRequirements. MY_PROGRAM (default) returns requirements as mapped in your program; CATALOG returns the framework's published requirements. Custom frameworks always use MY_PROGRAM. Both require the framework to be in your program.One of:
MY_PROGRAM,CATALOG. - Variants
variantslist - Catalog variant IDs to resolve CATALOG requirements against. Defaults to the framework's published defaults. Ignored for MY_PROGRAM, which uses your program's variants.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"activeVariants": [],
"description": "example",
"displayName": "example",
"id": "example",
"numControlsCompleted": 0,
"numControlsTotal": 0,
"numDocumentsPassing": 0,
"numDocumentsTotal": 0,
"numTestsPassing": 0,
"numTestsTotal": 0,
"requirementCategories": [],
"requirements": {
"items": [],
"scope": "example",
"variants": []
},
"shorthandName": "example",
"status": null
},
"has_more": false,
"next_cursor": null
}Get group
Get a group by ID.
Inputs
- Group
group_idtextRequired - Group id.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"creationDate": null,
"description": null,
"id": "example",
"name": "example",
"personnelCount": 0,
"pointOfContact": null,
"source": "example"
},
"has_more": false,
"next_cursor": null
}Get organization
Get the organization selected by the authenticated token.
Inputs
None.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"displayName": "example",
"id": "example",
"region": "example"
},
"has_more": false,
"next_cursor": null
}Get person
Get a person by ID.
Inputs
- Person
person_idtextRequired - Person id.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"emailAddress": "example",
"employment": {
"endDate": null,
"jobTitle": null,
"startDate": "example",
"status": "example"
},
"groupIds": [],
"id": "example",
"leaveInfo": null,
"name": {
"display": "example",
"first": null,
"last": null
},
"programScopeIds": [],
"sources": {
"emailAddress": {
"type": "example"
},
"employment": {
"endDate": {
"type": "example"
},
"startDate": {
"type": "example"
}
}
},
"tasksSummary": {
"completionDate": null,
"details": {
"acceptPolicies": {
"acceptedPolicies": [],
"completionDate": "example",
"disabled": {},
"dueDate": "example",
"status": "example",
"taskType": "example",
"unacceptedPolicies": []
},
"completeBackgroundChecks": {
"completionDate": "example",
"disabled": {},
"dueDate": "example",
"status": "example",
"taskType": "example"
},
"completeCustomTasks": {
"completedCustomTasks": [],
"completionDate": "example",
"disabled": {},
"dueDate": "example",
"incompleteCustomTasks": [],
"status": "example",
"taskType": "example"
},
"completeOffboardingCustomTasks": {
"completedCustomOffboardingTasks": [],
"completionDate": "example",
"disabled": {},
"dueDate": "example",
"incompleteCustomOffboardingTasks": [],
"status": "example",
"taskType": "example"
},
"completeTrainings": {
"completedTrainings": [],
"completionDate": "example",
"disabled": {},
"dueDate": "example",
"incompleteTrainings": [],
"status": "example",
"taskType": "example"
},
"installDeviceMonitoring": {
"completionDate": "example",
"disabled": {},
"dueDate": "example",
"status": "example",
"taskType": "example"
}
},
"dueDate": null,
"status": "example"
},
"userId": null
},
"has_more": false,
"next_cursor": null
}Get policy
Get a policy by ID.
Inputs
- Policy
policy_idtextRequired - Policy id.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"approvedAtDate": null,
"description": "example",
"id": "example",
"latestApprovedVersion": null,
"latestVersion": {
"status": "example"
},
"name": "example",
"status": "example"
},
"has_more": false,
"next_cursor": null
}Get test
Get a test by ID.
Inputs
- Test
test_idtextRequired - Test id.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"category": "example",
"deactivatedStatusInfo": {
"deactivatedReason": null,
"isDeactivated": false,
"lastUpdatedDate": null
},
"description": "example",
"failureDescription": "example",
"id": "example",
"integrations": [],
"lastTestRunDate": "example",
"latestFlipDate": null,
"name": "example",
"owner": null,
"remediationDescription": "example",
"remediationStatusInfo": {
"itemCount": 0,
"soonestRemediateByDate": null,
"status": "example"
},
"status": "example",
"version": {
"major": 0,
"minor": 0
}
},
"has_more": false,
"next_cursor": null
}Get vendor
Get a vendor.
Inputs
- Vendor
vendor_idtextRequired - Vendor id.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"accountManagerEmail": null,
"accountManagerName": null,
"additionalNotes": null,
"authDetails": {
"method": null,
"passwordMFA": null,
"passwordMinimumLength": null,
"passwordRequiresNumber": null,
"passwordRequiresSymbol": null
},
"businessOwnerUserId": null,
"category": null,
"contractAmount": null,
"contractRenewalDate": null,
"contractStartDate": null,
"contractTerminationDate": null,
"customFields": null,
"engagements": [],
"id": "example",
"inherentRiskLevel": "example",
"isRiskAutoScored": null,
"isVisibleToAuditors": null,
"lastSecurityReviewCompletionDate": null,
"latestDecision": null,
"linkedTaskTrackerTaskProcurementRequest": null,
"name": "example",
"nextSecurityReviewDueDate": null,
"parentVendor": null,
"residualRiskLevel": "example",
"riskAttributeIds": [],
"securityOwnerUserId": null,
"servicesProvided": null,
"status": "example",
"vendorHeadquarters": null,
"websiteUrl": null
},
"has_more": false,
"next_cursor": null
}List control documents
List a control's documents. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Control
control_idtextRequired - Control id.
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List control tests
List a control's tests. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Control
control_idtextRequired - Control id.
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List controls
List controls. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
- Framework matches any
framework_matches_anylist - Includes all controls belonging to one of the provided framework values in frameworkMatchesAny.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List document uploads
List the uploaded files for a document. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Document
document_idtextRequired - Document id.
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List documents
List documents. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
- Framework matches any
framework_matches_anylist - Includes all documents that match one of the provided framework values in frameworkMatchesAny.
- Status matches any
status_matches_anylist - Includes all documents that match one of the provided status values in statusMatchesAny.One or more of:
Needs document,Needs update,Not relevant,OK.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List event logs
List event logs. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
- Start date
start_datedate and time - Filter to event logs created at or after this ISO 8601 timestamp.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List framework controls
List a framework's controls. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Framework
framework_idtextRequired - Framework id.
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List frameworks
List frameworks in your program, or every available framework. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
- Include status
include_statustrue/false - Whether to include lifecycle status. Defaults to true.
- Purchased only
purchased_onlytrue/false - Whether to return only frameworks in your program. Defaults to true.
- Include progress
include_progresstrue/false - Whether to look up progress counts for purchased frameworks. Defaults to true. Counts are -1 when this is false and for unpurchased frameworks.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List groups
List all groups by ID. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List people
Get a list of all people. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
- Tasks summary status matches any
tasks_summary_status_matches_anylist - Filter individuals by those whose tasksSummary status is any of the provided values.One or more of:
COMPLETE,DUE_SOON,NONE,OFFBOARDING_COMPLETE,OFFBOARDING_DUE_SOON,OFFBOARDING_OVERDUE,OVERDUE,PAUSED. - Task type matches any
task_type_matches_anylist - Requires taskStatusMatchesAny. Includes all people for whom any of the provided taskType values in taskTypeMatchesAny is any of the provided taskStatus values in taskStatusMatchesAny.One or more of:
COMPLETE_TRAININGS,ACCEPT_POLICIES,COMPLETE_CUSTOM_TASKS,COMPLETE_CUSTOM_OFFBOARDING_TASKS,INSTALL_DEVICE_MONITORING,COMPLETE_BACKGROUND_CHECKS. - Task status matches any
task_status_matches_anylist - Requires taskTypeMatchesAny. Includes all people for whom any of the provided taskType values in taskTypeMatchesAny is any of the provided taskStatus values in taskStatusMatchesAny.One or more of:
COMPLETE,DUE_SOON,OVERDUE,NONE. - Email and name filter
email_and_name_filtertext - Filter people by email address, first name, or last name (partial match, case-insensitive).
- Group IDS matches any
group_ids_matches_anylist - Filter people matching any of the given group IDs.
- Employment status
employment_statustext - Filter people matching the given employment status.One of:
UPCOMING,CURRENT,ON_LEAVE,INACTIVE,FORMER. - Framework ID matches any
framework_id_matches_anylist - Filter people in scope for any of the given framework IDs. Framework IDs are built-in framework identifiers or custom framework ObjectIds. Blank IDs match nothing.
- Program scope ID matches any
program_scope_id_matches_anylist - Filter people in scope for any of the given program scope IDs. Program scopes you cannot view are ignored. Blank IDs match nothing.
- Business unit ID matches any
business_unit_id_matches_anylist - Filter people in scope for any of the given business unit IDs. Blank IDs match nothing.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List policies
List all policies. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List tests
List all tests based on applied filters. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
- Status filter
status_filtertext - Filter tests by test status. Possible values: OK (Test passed), DEACTIVATED (Test is deactivated), NEEDS_ATTENTION (Test failed), IN_PROGRESS (Test is in progress), INVALID (Test is invalid), NOT_APPLICABLE (Test is not applicable)One of:
OK,DEACTIVATED,NEEDS_ATTENTION,IN_PROGRESS,INVALID,NOT_APPLICABLE. - Framework filter
framework_filtertext - Filter tests by framework.
- Integration filter
integration_filtertext - Filter tests by integration.
- Control filter
control_filtertext - Filter tests by control ID.
- Owner filter
owner_filtertext - Filter tests by owner ID.
- Category filter
category_filtertext - Filter tests by category.One of:
ACCOUNTS_ACCESS,ACCOUNT_SECURITY,ACCOUNT_SETUP,COMPUTERS,CUSTOM,DATA_STORAGE,EMPLOYEES,INFRASTRUCTURE,IT,LOGGING, and 8 more. - Is in rollout
is_in_rollouttrue/false - Filter tests by rollout status. A test in rollout is an upcoming test that does not have its history tracked yet.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}List vendors
List of vendors. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
page_sizenumber - Controls the maximum number of items returned in one response from the API.From 1 to 100.
- Page cursor
page_cursortext - 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.
- Name
nametext - Filter vendors by name (case-insensitive, partial match)
- Status matches any
status_matches_anylist - Filter vendors by status (can specify multiple)One or more of:
MANAGED,ARCHIVED,IN_PROCUREMENT.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"results": {
"data": [],
"pageInfo": {
"endCursor": null,
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": null
}
}
},
"has_more": false,
"next_cursor": null
}Update group
Partially updates a group.
Inputs
- Group
group_idtextRequired - Group id.
- Point of contact email
point_of_contact_emailtext - Email of an active Vanta user with the Admin role in the organization. Omit to preserve; pass null to clear.
- Description
descriptiontext - New description. Omit to preserve; pass null to clear.
- Name
nametext - New display name. Omit to preserve. Names are trimmed, must be non-empty and unique, and cannot change for an IdP-managed group.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"creationDate": null,
"description": null,
"id": "example",
"name": "example",
"personnelCount": 0,
"pointOfContact": null,
"source": "example"
},
"has_more": false,
"next_cursor": null
}