Skip to content
bynhDocs

List certificates

GET/workspaces/{workspace}/certificates

Returns every certificate in the workspace, sorted by name, expired ones included. A trust center never hides a lapsed certificate.

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.

Query parameters

  • qstring

    Searches name, issuer and description (contains, case follows the database). Trimmed and cut to 100 characters; % and _ are matched literally.

Response

200 OK

Array of certificates without documents. Not paginated.

  • idintegerCertificate id.
  • namestringThe standard, e.g. ISO/IEC 27001:2022.
  • descriptionstring|nullShort line under the name.
  • issuerstringWho issued it.
  • certificate_numberstring|nullThe number on the certificate.
  • statusenumDerived from valid_until on every save: expired after the date, renewing within 30 days of it, otherwise valid. in_audit is the only status you set (with in_audit: true). One of valid, renewing, in_audit, expired.
  • issued_onstring|nullYYYY-MM-DD.
  • valid_untilstring|nullYYYY-MM-DD.
  • days_leftinteger|nullDays from today to valid_until; negative once expired.
  • scopestring|nullScope statement.
  • notestring|nullShort note.
  • show_badgebooleanShow a badge on the trust center.
  • allow_downloadbooleanLet visitors download the certificate.
  • share_soa_after_ndabooleanShare the Statement of Applicability after an NDA.
  • publishedbooleanShown on the trust center.

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 →Add a certificate
curl "https://api.bynh.io/api/v1/workspaces/dokan/certificates?q=ISO" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": [
    {
      "id": 7,
      "name": "ISO/IEC 27001:2022",
      "description": "Information security management",
      "issuer": "BSI Group",
      "certificate_number": "IS 781203",
      "status": "valid",
      "issued_on": "2025-03-10",
      "valid_until": "2028-03-09",
      "days_left": 890,
      "scope": "Dokan commerce platform, Riyadh operations and AWS me-south-1 hosting.",
      "note": null,
      "show_badge": true,
      "allow_download": true,
      "share_soa_after_nda": true,
      "published": true
    },
    {
      "id": 9,
      "name": "PCI DSS v4.0.1",
      "description": "Card data security",
      "issuer": "Trustwave",
      "certificate_number": null,
      "status": "renewing",
      "issued_on": "2025-10-20",
      "valid_until": "2026-10-19",
      "days_left": 18,
      "scope": "Dokan Pay card processing",
      "note": "Assessment booked for 12 October",
      "show_badge": true,
      "allow_download": false,
      "share_soa_after_nda": false,
      "published": true
    }
  ]
}

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