Skip to content

Standards

import { Aside } from ‘@astrojs/starlight/components’;

GET /v1/organizations/:orgId/standards

Required role: Member.

Returns all standards visible to the organization: global built-in standards plus any custom standards the organization has created.

Response:

{
"standards": [
{
"id": "...",
"name": "WCAG 2.2",
"slug": "wcag-2-2",
"description": "...",
"source": "built_in",
"editable": false,
"organizationId": null,
"cumulative": true,
"levels": [
{ "id": "a", "name": "Level A", "sortOrder": 0 },
{ "id": "aa", "name": "Level AA", "sortOrder": 1 },
{ "id": "aaa", "name": "Level AAA", "sortOrder": 2 }
],
"createdAt": "...",
"updatedAt": "..."
}
]
}

POST /v1/organizations/:orgId/standards

Required role: Admin or owner.

Request body:

FieldTypeRequiredDescription
namestringYesStandard name.
descriptionstring | nullNoOptional description.
levelsarrayNoOrdered conformance levels. Each item: { name: string, description?: string }.
cumulativebooleanNoWhether meeting a higher level implies all lower levels (default: false).

Returns 201 Created.


PATCH /v1/organizations/:orgId/standards/:standardSlug

Required role: Admin or owner. Built-in standards cannot be updated.

Request body (all fields optional):

FieldTypeDescription
namestring
descriptionstring | null
levelsarrayReplaces the full set of levels. Removing a level that is referenced by products, organizations, or audits clears those references.
cumulativeboolean

DELETE /v1/organizations/:orgId/standards/:standardSlug

Required role: Admin or owner. Built-in standards cannot be deleted.

Clears any references to this standard on organizations, products, and audits. Returns 204 No Content.


POST /v1/organizations/:orgId/standards/:standardSlug/duplicate

Required role: Admin or owner.

Creates an editable custom copy of any standard, including built-in ones. The copy includes all requirement groups and requirements. Returns 201 Created.


GET /v1/organizations/:orgId/standards/:standardSlug/requirements

Required role: Member.

Query parameters:

ParameterTypeDescription
versionstringFilter by version tag.
levelstringFilter by conformance level ID.

POST /v1/organizations/:orgId/standards/:standardSlug/requirements

Required role: Admin or owner. Custom standards only.

Request body:

FieldTypeRequiredDescription
namestringYesShort criterion title.
descriptionstring | nullNoFull description.
urlstring | nullNoLink to an external reference.
levelstring | nullNoConformance level ID this requirement belongs to.
versionsstring[]NoVersion tags (e.g. ["2.1", "2.2"]).
aiTestablebooleanNoWhether this can be evaluated by automated tooling.
groupIdstring | nullNoRequirement group to place this in.
metadataobjectNoArbitrary key/value metadata.

PATCH /v1/organizations/:orgId/standards/:standardSlug/requirements/:requirementId

Required role: Admin or owner. Custom standards only.

Accepts the same fields as the create body, all optional.


DELETE /v1/organizations/:orgId/standards/:standardSlug/requirements/:requirementId

Required role: Admin or owner. Custom standards only.

Returns 204 No Content.


POST /v1/organizations/:orgId/standards/:standardSlug/groups

Required role: Admin or owner. Custom standards only.

Request body:

FieldTypeRequiredDescription
namestringYesGroup name.
descriptionstring | nullNoOptional description.
parentIdstring | nullNoParent group ID for nested groups. Circular references are rejected.

PATCH /v1/organizations/:orgId/standards/:standardSlug/groups/:groupId

Required role: Admin or owner. Custom standards only.

Accepts the same fields as the create body, all optional.


DELETE /v1/organizations/:orgId/standards/:standardSlug/groups/:groupId

Required role: Admin or owner. Custom standards only.

Returns 204 No Content.