Standards
import { Aside } from ‘@astrojs/starlight/components’;
List standards
Section titled “List standards”GET /v1/organizations/:orgId/standardsRequired 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": "..." } ]}Create a custom standard
Section titled “Create a custom standard”POST /v1/organizations/:orgId/standardsRequired role: Admin or owner.
Request body:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Standard name. |
description | string | null | No | Optional description. |
levels | array | No | Ordered conformance levels. Each item: { name: string, description?: string }. |
cumulative | boolean | No | Whether meeting a higher level implies all lower levels (default: false). |
Returns 201 Created.
Update a custom standard
Section titled “Update a custom standard”PATCH /v1/organizations/:orgId/standards/:standardSlugRequired role: Admin or owner. Built-in standards cannot be updated.
Request body (all fields optional):
| Field | Type | Description |
|---|---|---|
name | string | |
description | string | null | |
levels | array | Replaces the full set of levels. Removing a level that is referenced by products, organizations, or audits clears those references. |
cumulative | boolean |
Delete a custom standard
Section titled “Delete a custom standard”DELETE /v1/organizations/:orgId/standards/:standardSlugRequired 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.
Duplicate a standard
Section titled “Duplicate a standard”POST /v1/organizations/:orgId/standards/:standardSlug/duplicateRequired 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.
List requirements
Section titled “List requirements”GET /v1/organizations/:orgId/standards/:standardSlug/requirementsRequired role: Member.
Query parameters:
| Parameter | Type | Description |
|---|---|---|
version | string | Filter by version tag. |
level | string | Filter by conformance level ID. |
Create a requirement
Section titled “Create a requirement”POST /v1/organizations/:orgId/standards/:standardSlug/requirementsRequired role: Admin or owner. Custom standards only.
Request body:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Short criterion title. |
description | string | null | No | Full description. |
url | string | null | No | Link to an external reference. |
level | string | null | No | Conformance level ID this requirement belongs to. |
versions | string[] | No | Version tags (e.g. ["2.1", "2.2"]). |
aiTestable | boolean | No | Whether this can be evaluated by automated tooling. |
groupId | string | null | No | Requirement group to place this in. |
metadata | object | No | Arbitrary key/value metadata. |
Update a requirement
Section titled “Update a requirement”PATCH /v1/organizations/:orgId/standards/:standardSlug/requirements/:requirementIdRequired role: Admin or owner. Custom standards only.
Accepts the same fields as the create body, all optional.
Delete a requirement
Section titled “Delete a requirement”DELETE /v1/organizations/:orgId/standards/:standardSlug/requirements/:requirementIdRequired role: Admin or owner. Custom standards only.
Returns 204 No Content.
Create a requirement group
Section titled “Create a requirement group”POST /v1/organizations/:orgId/standards/:standardSlug/groupsRequired role: Admin or owner. Custom standards only.
Request body:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Group name. |
description | string | null | No | Optional description. |
parentId | string | null | No | Parent group ID for nested groups. Circular references are rejected. |
Update a requirement group
Section titled “Update a requirement group”PATCH /v1/organizations/:orgId/standards/:standardSlug/groups/:groupIdRequired role: Admin or owner. Custom standards only.
Accepts the same fields as the create body, all optional.
Delete a requirement group
Section titled “Delete a requirement group”DELETE /v1/organizations/:orgId/standards/:standardSlug/groups/:groupIdRequired role: Admin or owner. Custom standards only.
Returns 204 No Content.