Skip to main content
GET
Get framework by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

frameworkId
string
required

Query Parameters

includeStatus
boolean
default:true

Whether to include lifecycle status. Defaults to true.

includeRequirements
boolean
default:false

Whether to include the flat requirements list. Defaults to false.

requirementsScope
enum<string>
default:MY_PROGRAM

Used with includeRequirements. MY_PROGRAM (default) returns requirements as mapped in your program; CATALOG returns the framework's published requirements. Custom frameworks always use MY_PROGRAM. Both require the framework to be in your program.

Available options:
MY_PROGRAM,
CATALOG
variants
string[]

Catalog variant IDs to resolve CATALOG requirements against. Defaults to the framework's published defaults. Ignored for MY_PROGRAM, which uses your program's variants.

Response

200 - application/json

Ok

id
string
required

The framework's unique ID.

displayName
string
required

The framework's display name.

shorthandName
string
required

The short version of the framework's display name.

description
string
required

The framework's description.

numControlsCompleted
number<double>
required

The number of completed controls in the framework.

numControlsTotal
number<double>
required

The total number of controls in the framework.

numDocumentsPassing
number<double>
required

The number of passing documents in the framework.

numDocumentsTotal
number<double>
required

The total number of documents in the framework.

numTestsPassing
number<double>
required

The number of passing tests in the framework.

numTestsTotal
number<double>
required

The total number of tests in the framework.

requirementCategories
object[]
required

The famework's list of requirement categories.

status
enum<string> | null

The framework's lifecycle status. Null means it has no lifecycle status. Omitted when includeStatus is false or status information is unavailable.

Available options:
ACTIVE,
DRAFT,
SNOOZED,
ARCHIVED,
NEW_UPGRADE,
null
activeVariants
object[]

The assessment tiers your program is on, such as HITRUST i1. Omitted for frameworks without tiers.

requirements
object

The framework's requirements as a flat list that preserves their hierarchy. Omitted when requirements are unavailable.