Policies
List compliance policies
List compliance policies for an organization, including drafts and published policies used for SOC 2, ISO 27001, HIPAA, and GDPR workflows.
get/v1/policies
Headers
X-Organization-Idstring
Organization ID (required for session auth, optional for API key auth)
Response
Policies retrieved successfully
Example response
{
"data": [
{
"id": "pol_abc123def456",
"name": "Data Privacy Policy",
"description": "This policy outlines how we handle and protect personal data",
"status": "draft",
"content": [
{
"type": "heading",
"attrs": {
"level": 2,
"textAlign": null
},
"content": [
{
"type": "text",
"text": "Purpose"
}
]
},
{
"type": "paragraph",
"attrs": {
"textAlign": null
},
"content": [
{
"type": "text",
"text": "Verify workforce integrity and grant the right access at start, revoke at end."
}
]
}
],
"frequency": "yearly",
"department": "it",
"isRequiredToSign": true,
"signedBy": [
"usr_123",
"usr_456"
],
"reviewDate": "2024-12-31T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-15T00:00:00.000Z",
"lastArchivedAt": "2024-02-01T00:00:00.000Z",
"lastPublishedAt": "2024-01-10T00:00:00.000Z",
"organizationId": "org_abc123def456",
"assigneeId": "usr_abc123def456",
"approverId": "usr_xyz789abc123",
"policyTemplateId": "plt_template123"
}
],
"authenticatedUser": {
"id": "usr_abc123def456",
"email": "user@company.com"
}
}