Skip to content

Get policy

GET
/api/v1/organizations/{orgId}/policies/{policyId}
curl --request GET \
--url https://localhost:10001/api/v1/organizations/1/policies/1 \
--header 'Authorization: <Authorization>'

Retrieve a specific policy by ID, including its controls

orgId
required
integer

Organization ID

policyId
required
integer

Policy ID

Policy with controls

Media type application/json
object
controls

Controls within the policy, omitted but populated in list operations

Array<object>
object
citations
Array<object>
object
title
string
url
string
controlCode
string
createdAt
string
description
string
id
integer
policyId
integer
title
string
updatedAt
string
createdAt
string
description
string
iconUrl
string
id
integer
name
string
organizationId
integer
slug
string
type

Risk Management, Internal, Regulatory, Custom

string
Allowed values: Risk Management Internal Regulatory Custom
updatedAt
string
version
string
Example
{
"type": "Risk Management"
}

Bad request - Invalid organization ID or policy ID

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Forbidden - No organization access

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Policy not found

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Internal server error

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}