Controls
Get control by an ID
Get a control by an ID.
get/controls/{controlId}
Path parameters
controlIdstring required
Response
Ok
idstring required
The control's unique ID.
externalIdstring nullable required
The control's external ID.
namestring required
The control's name.
descriptionstring required
The control's description.
source'Vanta' | 'Custom' required
domainsstring[] required
The security domains that the control belongs to.
rolestring nullable
The control's GDPR role, if the control is a GDPR control.
creationDatestring date-time nullable required
When the control was created. Returns null for Vanta library controls.
modificationDatestring date-time nullable required
When the control was last modified. Returns null for Vanta library controls.
numDocumentsPassingnumber double required
The number of passing documents that are linked to the control.
numDocumentsTotalnumber double required
The total number of documents that are linked to the control.
numTestsPassingnumber double required
The number of passing tests that are linked to the control.
numTestsTotalnumber double required
The total number of tests that are linked to the control.
status'NO_EVIDENCE_MAPPED' | 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' required
notestring nullable required
A user created note for the control.