Get the workspace

GET/workspaces/{workspace}

Returns the workspace your token belongs to: its name, trust center address, active layers, language and time zone, and how many certificates it holds.

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

A WorkspaceResource wrapped in data.

idintegerWorkspace id.
namestringCompany name.
slugstringUsed in every workspace path.
domainstring|nullCustom trust center domain, if set.
addressstringdomain, or {slug}.bynh.io.
accent_colorstring|nullTrust center accent colour.
modulesenumLayers switched on. One of trust, certs, policies, status, disclosure, subprocessors, questionnaires, domain.
trial_ends_atstring|nullISO 8601.
editing_paused_atstring|nullSet when editing is paused for billing; writes return 403 while set.
onboardedbooleanOnboarding finished.
languagesarray<string>Trust center languages, default ["en"].
timezonestringDefault Asia/Riyadh.
deletion_scheduled_atstring|nullWhen deletion was scheduled.
purge_afterstring|nulldeletion_scheduled_at + 30 days.
certificates_countintegerNumber of certificates.

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 certificates

curl "https://api.bynh.io/api/v1/workspaces/dokan" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json

{
  "data": {
    "id": 3,
    "name": "Dokan",
    "slug": "dokan",
    "domain": "trust.dokan.sa",
    "address": "trust.dokan.sa",
    "accent_color": "#C9A86A",
    "modules": [
      "trust",
      "certs",
      "policies",
      "status",
      "disclosure",
      "subprocessors"
    ],
    "trial_ends_at": null,
    "editing_paused_at": null,
    "onboarded": true,
    "languages": [
      "en",
      "ar"
    ],
    "timezone": "Asia/Riyadh",
    "deletion_scheduled_at": null,
    "purge_after": null,
    "certificates_count": 5
  }
}

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