Skip to content

Issues

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

GET /v1/organizations/:orgId/issues

Required role: Member.

Returns a paginated list of issues across all products in the organization.

Query parameters:

ParameterTypeDescription
pageintegerPage number (default: 1).
pageSizeintegerResults per page (default: 25, max: 100).
state"open" | "closed"Filter by state.
severity"high" | "medium" | "low"Filter by severity.
impact"high" | "medium" | "low"Filter by impact.
effort"high" | "medium" | "low"Filter by effort.
priority"critical" | "high" | "medium" | "low"Filter by priority.
source"ablebase" | "github"Filter by source.
productIdstringFilter to a specific product.
sortFieldstringField to sort by (e.g. "createdAt", "severity", "priority").
sortDirection"asc" | "desc"Sort direction (default: "desc").

Response:

{
"issues": [...],
"total": 142,
"page": 1,
"pageSize": 25
}

Each issue includes an areas array of associated area objects.


GET /v1/organizations/:orgId/issues/insights

Required role: Member.

Returns aggregated breakdowns of all issues in the organization:

  • By severity, priority, impact, effort, state
  • By conformance level
  • Top 10 requirements by issue count
  • By product

GET /v1/organizations/:orgId/products/:productSlug/issues

Required role: Member.

Accepts the same query parameters as the organization-level list, excluding productId.


POST /v1/organizations/:orgId/products/:productSlug/issues

Required role: Member.

Cannot create an issue in an archived product — returns 409 Conflict.

Request body:

FieldTypeRequiredDescription
titlestringYesIssue title (max 200 characters).
descriptionstring | nullNoFull description (max 2000 characters).
severity"high" | "medium" | "low" | nullNoSeverity level.
impact"high" | "medium" | "low" | nullNoUser impact.
effort"high" | "medium" | "low" | nullNoRemediation effort estimate.
priority"critical" | "high" | "medium" | "low" | nullNoPriority.
source"ablebase" | "github"NoSource system (default: "ablebase").
sourceUrlstring | nullNoURL of the external issue (e.g. GitHub issue URL).
sourceIdstring | nullNoExternal issue ID.
auditIdstring | nullNoID of the audit this issue was found in.
areaIdsstring[]NoIDs of areas to tag.

Issue numbers are sequential per product, assigned atomically. Returns 201 Created with a Location header.


GET /v1/organizations/:orgId/products/:productSlug/issues/:issueNumber

Required role: Member.

:issueNumber is the sequential integer issue number. The response includes an areas array.


PATCH /v1/organizations/:orgId/products/:productSlug/issues/:issueNumber

Required role: Member.

Request body (all fields optional):

FieldTypeDescription
titlestring
descriptionstring | null
state"open" | "closed"
severity"high" | "medium" | "low" | null
impact"high" | "medium" | "low" | null
effort"high" | "medium" | "low" | null
priority"critical" | "high" | "medium" | "low" | null
sourceUrlstring | null
sourceIdstring | null
auditIdstring | null
areaIdsstring[]Replaces the full set of area associations.

DELETE /v1/organizations/:orgId/products/:productSlug/issues/:issueNumber

Required role: Admin or owner.

Returns 204 No Content.


GET /v1/organizations/:orgId/products/:productSlug/issues/:issueNumber/requirements

Required role: Member.

Returns all standard requirements linked to the issue.


PUT /v1/organizations/:orgId/products/:productSlug/issues/:issueNumber/requirements

Required role: Member.

Replaces the full set of requirement links for the issue. Send an empty array to remove all links.

Request body:

FieldTypeDescription
requirementIdsstring[]IDs of requirements to link.

PATCH /v1/organizations/:orgId/issues/bulk

Required role: Member.

Updates up to 100 issues at once.

Request body:

FieldTypeDescription
idsstring[]Issue IDs to update (max 100).
data.state"open" | "closed"Optional.
data.severity"high" | "medium" | "low" | nullOptional.
data.impact"high" | "medium" | "low" | nullOptional.
data.effort"high" | "medium" | "low" | nullOptional.
data.priority"critical" | "high" | "medium" | "low" | nullOptional.

DELETE /v1/organizations/:orgId/issues/bulk

Required role: Admin or owner.

Request body:

FieldTypeDescription
idsstring[]Issue IDs to delete (max 100).