# Get the company's WorkOS roles sync status

Needs company access admins at view.

`GET /api/v1/public/workspaces/workspaceId/enterprise/workos-roles`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs company access `admins` at `view`. Returns the state, what is published, the roles people carry and any issues, read from the app owner's own WorkOS account.

## Request

| Field         | Type   | Required | Constraints | Description |
| ------------- | ------ | -------- | ----------- | ----------- |
| `workspaceId` | string | Yes      | -           | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X GET "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workos-roles" \
  -H "x-session-id: $BUILDBASE_SESSION_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workos-roles',
  {
    method: 'GET',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
    },
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/workos-roles",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "checks": {
    "multipleRolesSeen": false,
    "roleAssignmentSeen": false
  },
  "enabled": true,
  "issues": [
    {
      "code": "[REDACTED]",
      "item": "security-admin",
      "sentence": "A published role is gone from WorkOS.",
      "since": "2026-01-01T00:00:00.000Z"
    },
    {
      "code": "[REDACTED]",
      "item": "auditor",
      "sentence": "A published role's name or description in WorkOS differs from the one in the app.",
      "since": "2026-01-01T00:00:00.000Z"
    }
  ],
  "lastGoodReadAt": "2026-01-01T00:00:00.000Z",
  "published": [
    {
      "id": "security-admin",
      "kind": "preset",
      "name": "Security admin",
      "slug": "org-bb-security-admin",
      "state": "published"
    },
    {
      "id": "auditor",
      "kind": "preset",
      "name": "Auditor",
      "slug": "org-bb-auditor",
      "state": "published"
    },
    {
      "id": "000000000000000000000001",
      "kind": "role",
      "name": "Service desk",
      "slug": "org-bb-service-desk",
      "state": "published"
    },
    {
      "id": "000000000000000000000002",
      "kind": "group",
      "name": "Design editors",
      "slug": "org-bb-group-design-editors",
      "state": "published"
    }
  ],
  "readAt": "2026-01-01T00:00:00.000Z",
  "seen": [],
  "state": "needs_attention",
  "workosRolesFrom": "auto"
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Workspaces guide](/workspaces/overview): how this part of BuildBase works
- [All Workspaces operations](/http-api/reference/workspaces)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `workspaces.enterprise.workosRoles.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
