Get policy

GET

/api/v1/organizations/{orgId}/policies/{policyId}

const url = 'https://localhost:10001/api/v1/organizations/example/policies/example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://localhost:10001/api/v1/organizations/example/policies/example \
  --header 'Authorization: <Authorization>'

Retrieve a specific policy by ID, including its controls

Authorizations

BearerAuth

Parameters

Path Parameters

orgId

required

string

Organization ID or UUID (urn:uuid optional)

policyId

required

string

Policy ID, slug:my-policy@1.2.0, or urn:cid:bafy…

Responses

200

Policy with controls

application/json

A reusable template of controls in the organization’s library, applied to projects rather than used directly

object

cid

Assigned by the integrity service at creation

string

controls

Present on read, ignored on update

Array<object>

A single requirement within a policy template, identified by its control code

object

cid

Assigned by the integrity service at creation

string

citations

Array<object>

object

title

string

url

string

controlCode

Alphanumeric, . and -; upper-cased

string

createdAt

string format: date-time

description

string

integer

policyId

Assigned from the parent policy

integer

title

string

updatedAt

string format: date-time

createdAt

string format: date-time

description

string

iconUrl

string

integer

name

string

organizationId

Taken from the path on create

integer

slug

Derived from name

string

type

See PolicyType for values

string

Allowed values: Risk Management Internal Regulatory Custom

updatedAt

string format: date-time

version

string

Example

{
  "type": "Risk Management"
}

400

Bad request - Invalid organization ID or policy ID

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

401

Unauthorized - Authentication required

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

403

Forbidden - No organization access

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

404

Policy not found

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

500

Internal server error

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}