Skip to content
bynhDocs

List requirements you can map

GET/workspaces/{workspace}/evidence/requirements

Returns every requirement across the frameworks you follow, for mapping evidence and policies.

Authentication

Send an API token as a bearer token. This endpoint needs a read token, made by any member of the workspace. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

  • workspacestringRequired

    Your workspace slug, e.g. dokan.

Response

200 OK

Flat list, grouped by framework in follow order.

  • idintegerRequirement id.
  • codestringRequirement code.
  • titlestringLocalized title.
  • sectionstring|nullLocalized section.
  • framework{slug, short_name}Its framework.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute. When you go over, wait for the number of seconds in Retry-After.

Errors

401The token is missing, wrong, revoked or expired.
404The token belongs to another workspace, or its owner is no longer a member.

Every error is JSON with a message. See Errors.

Next →Assign a requirement
curl "https://api.bynh.io/api/v1/workspaces/dokan/evidence/requirements" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": [
    {
      "id": 1204,
      "code": "A.5.15",
      "title": "Access control",
      "section": "Organizational controls",
      "framework": {
        "slug": "iso-27001",
        "short_name": "ISO 27001"
      }
    },
    {
      "id": 2311,
      "code": "8.3.1",
      "title": "Strong authentication for users and administrators",
      "section": "Requirement 8",
      "framework": {
        "slug": "pci-dss",
        "short_name": "PCI DSS"
      }
    }
  ]
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.