Get compliance policy

Authorizations

X-API-Key

string

header

required

API key for authentication

Headers

X-Organization-Id

string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

string

required

Policy ID

Example:

"pol_abc123def456"

Response

Policy retrieved successfully

string

required

The policy ID

Example:

"pol_abc123def456"

name

string

required

Name of the policy

Example:

"Data Privacy Policy"

type

enum<string>

default:policy

required

Kind of document (ENG-898). Policies only are signable and appear on the trust portal; standards and procedures share everything else.

Available options:

policy,

standard,

procedure

Example:

"policy"

description

string | null

required

Description of the policy

Example:

"This policy outlines how we handle and protect personal data"

status

enum<string>

required

Status of the policy

Available options:

draft,

published,

needs_review

Example:

"draft"

content

object[]

required

Content of the policy as TipTap JSON (array of nodes)

Example:

[
  {
    "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

enum<string> | null

required

Review frequency of the policy

Available options:

monthly,

quarterly,

yearly

Example:

"yearly"

department

string | null

required

Department this policy applies to. May be one of the built-in values (none, admin, gov, hr, it, itsm, qms) or a custom department name.

Example:

"it"

isRequiredToSign

boolean

required

Whether this policy requires a signature

Example:

true

signedBy

string[]

required

List of user IDs who have signed this policy

Example:

["usr_123", "usr_456"]

reviewDate

string<date-time> | null

required

Review date for the policy

Example:

"2024-12-31T00:00:00.000Z"

isArchived

boolean

required

Whether this policy is archived

Example:

false

archivedAt

string<date-time> | null

required

When the policy was archived by framework sync

Example:

"2024-02-01T00:00:00.000Z"

createdAt

string<date-time>

required

When the policy was created

Example:

"2024-01-01T00:00:00.000Z"

updatedAt

string<date-time>

required

When the policy was last updated

Example:

"2024-01-15T00:00:00.000Z"

lastArchivedAt

string<date-time> | null

required

When the policy was last archived

Example:

"2024-02-01T00:00:00.000Z"

lastPublishedAt

string<date-time> | null

required

When the policy was last published

Example:

"2024-01-10T00:00:00.000Z"

organizationId

string

required

Organization ID this policy belongs to

Example:

"org_abc123def456"

assigneeId

string | null

required

Member ID of the organization member this policy is assigned to — the id of the expanded assignee

Example:

"mem_abc123def456"

approverId

string | null

required

Member ID of the organization member who approved this policy

Example:

"mem_xyz789abc123"

policyTemplateId

string | null

required

ID of the policy template this policy is based on

Example:

"plt_template123"

visibility

enum<string>

Who has to sign this policy: ALL employees, or a restricted audience (DEPARTMENT) matching visibleToDepartments or visibleToMemberIds.

Available options:

ALL,

DEPARTMENT

Example:

"ALL"

visibleToDepartments

string[]

Departments included in the restricted audience. Individual members in visibleToMemberIds are included too.

Example:

["hr"]

visibleToMemberIds

string[]

Individual organization member IDs included in the restricted policy audience.

Example:

["mem_abc123def456"]

outgoingReferences

object[]

Documents this document references (ENG-898), e.g. a standard pointing at the policies it implements. Present on single-document responses.

Show child attributes

incomingReferences

object[]

Documents that reference this document (read-only reverse half of outgoingReferences). Present on single-document responses.

Show child attributes

Overview

Reference

Get compliance policy | Comp AI API

Authorizations

Headers

Path Parameters

Response