Skip to content
bynhDocs
Log in

List policies

GET/workspaces/{workspace}/policies

Returns every policy, sorted by title, with its status and review date, plus counts, the policy templates you can start from and the people who can own 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

Rows in data; extra top-level keys meta, templates, people. Not paginated.

  • idintegerPolicy id (used in paths).
  • slugstringUsed in the public URL.
  • titlestringName.
  • summarystring|nullOne-line summary.
  • owner{id, name}|nullOwner.
  • visibilityenumWhere it appears. One of public, nda, internal.
  • visibility_labelstringLocalized.
  • review_every_daysenumReview cadence. One of 90, 180, 365, 730.
  • next_review_atstring|nullYYYY-MM-DD.
  • statusenumDerived from the open version and review date. One of draft, in_review, changes_requested, published, review_due, overdue.
  • published_versioninteger|nullPublished version number.
  • published_atstring|nullISO 8601.
  • open_versionobject|nullnumber, status (draft | in_review | changes_requested), reviewer {id, name}|null, waiting_on_you (for the token owner).
  • taglinestringLocalized one-liner, e.g. “v3 · v4 in draft”.
  • requirements_countintegerMapped requirements.
  • metaobjecttotal, published, due (review_due + overdue), waiting_on_you.
  • templates[]objectkey, title, summary, covers (requirement count).
  • people[]objectid, 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 →Create a policy
curl "https://api.bynh.io/api/v1/workspaces/dokan/policies" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": [
    {
      "id": 6,
      "slug": "access-control",
      "title": "Access control",
      "summary": "Who can reach Dokan systems and data, and how access is granted and removed.",
      "owner": {
        "id": 14,
        "name": "Sara Alqahtani"
      },
      "visibility": "public",
      "visibility_label": "Public",
      "review_every_days": 365,
      "next_review_at": "2027-04-14",
      "status": "published",
      "published_version": 3,
      "published_at": "2026-04-14T11:20:00+00:00",
      "open_version": null,
      "tagline": "v3 · Added MFA for the back office",
      "requirements_count": 4
    }
  ],
  "meta": {
    "total": 9,
    "published": 7,
    "due": 1,
    "waiting_on_you": 0
  },
  "templates": [
    {
      "key": "data-retention",
      "title": "Data retention",
      "summary": "How long each kind of data is kept, and how it’s deleted.",
      "covers": 6
    }
  ],
  "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.