Skip to content
bynhDocs
Log in

Get coverage

GET/workspaces/{workspace}/evidence

Returns the frameworks you follow with how much of each you can prove, totals across them, a count of your evidence by status, the full framework catalogue, and the people who can own evidence.

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

Coverage overview.

  • frameworks[]objectOne per followed framework: slug, name, short_name, version, in_audit, total, met, gaps, percent. percent never rounds up to 100 while a gap is open (max 99).
  • totalsobjectpercent (null until you follow a framework), open_gaps, met, total.
  • evidenceobjecttotal plus counts for current, due, overdue, pending.
  • catalog[]objectEvery framework bynh supports: slug, name, short_name, version, publisher, requirements (count).
  • people[]objectMembers who can edit: id, name, role.

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 →List a framework’s requirements
curl "https://api.bynh.io/api/v1/workspaces/dokan/evidence" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": {
    "frameworks": [
      {
        "slug": "iso-27001",
        "name": "ISO/IEC 27001:2022",
        "short_name": "ISO 27001",
        "version": "2022, Annex A",
        "in_audit": false,
        "total": 93,
        "met": 71,
        "gaps": 22,
        "percent": 76
      },
      {
        "slug": "pci-dss",
        "name": "PCI DSS v4.0.1",
        "short_name": "PCI DSS",
        "version": "v4.0.1",
        "in_audit": true,
        "total": 64,
        "met": 40,
        "gaps": 24,
        "percent": 63
      }
    ],
    "totals": {
      "percent": 70,
      "open_gaps": 46,
      "met": 111,
      "total": 157
    },
    "evidence": {
      "total": 38,
      "current": 29,
      "due": 4,
      "overdue": 2,
      "pending": 3
    },
    "catalog": [
      {
        "slug": "soc-2",
        "name": "SOC 2",
        "short_name": "SOC 2",
        "version": "Trust Services Criteria 2017",
        "publisher": "AICPA",
        "requirements": 61
      },
      {
        "slug": "iso-27001",
        "name": "ISO/IEC 27001:2022",
        "short_name": "ISO 27001",
        "version": "2022, Annex A",
        "publisher": "ISO/IEC",
        "requirements": 93
      },
      {
        "slug": "pci-dss",
        "name": "PCI DSS v4.0.1",
        "short_name": "PCI DSS",
        "version": "v4.0.1",
        "publisher": "PCI Security Standards Council",
        "requirements": 64
      }
    ],
    "people": [
      {
        "id": 21,
        "name": "Faisal Alharbi",
        "role": "editor"
      },
      {
        "id": 14,
        "name": "Sara Alqahtani",
        "role": "owner"
      }
    ]
  }
}

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