# List the company's sign-in audit trail

Needs the activity area at view.

`GET /api/v1/public/workspaces/workspaceId/enterprise/audit`

- 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 the `activity` area at `view`. Returns the company's sign-ins, refusals, provisioning, certificate and setup entries, limited to the app plan's audit retention window.

## 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/audit" \
  -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/audit',
  {
    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/audit",
    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"
{
  "entries": [
    {
      "action": "enterprise_group_updated",
      "actor": null,
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [
          {
            "groupId": "000000000000000000000002",
            "name": "On-call"
          }
        ],
        "group": "Security reviewers",
        "groupId": "000000000000000000000003",
        "included": [],
        "reached": 1,
        "via": "console"
      },
      "id": "000000000000000000000004",
      "ip": null,
      "userAgent": null
    },
    {
      "action": "enterprise_group_updated",
      "actor": null,
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [],
        "group": "Security reviewers",
        "groupId": "000000000000000000000003",
        "included": [
          {
            "groupId": "000000000000000000000002",
            "name": "On-call"
          }
        ],
        "reached": 1,
        "via": "console"
      },
      "id": "000000000000000000000005",
      "ip": null,
      "userAgent": null
    },
    {
      "action": "enterprise_group_updated",
      "actor": null,
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [],
        "group": "Platform",
        "groupId": "000000000000000000000006",
        "included": [
          {
            "groupId": "000000000000000000000002",
            "name": "On-call"
          }
        ],
        "keyId": "[REDACTED]",
        "keyName": "[REDACTED]",
        "keyOwner": "[REDACTED]",
        "reached": 1,
        "via": "api"
      },
      "id": "000000000000000000000007",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    },
    {
      "action": "enterprise_group_updated",
      "actor": {
        "email": "user@example.com",
        "id": "000000000000000000000008",
        "name": "Session User m23-nested-gus"
      },
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [],
        "group": "Engineering",
        "groupId": "000000000000000000000009",
        "included": [
          {
            "groupId": "000000000000000000000010",
            "name": "Backend"
          }
        ],
        "reached": 2,
        "via": "app",
        "workspaceId": "000000000000000000000011"
      },
      "id": "000000000000000000000012",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    },
    {
      "action": "enterprise_group_updated",
      "actor": {
        "email": "user@example.com",
        "id": "000000000000000000000008",
        "name": "Session User m23-nested-gus"
      },
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [
          {
            "groupId": "000000000000000000000010",
            "name": "Backend"
          }
        ],
        "group": "Engineering",
        "groupId": "000000000000000000000009",
        "included": [],
        "reached": 2,
        "via": "app",
        "workspaceId": "000000000000000000000011"
      },
      "id": "000000000000000000000013",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    },
    {
      "action": "enterprise_group_updated",
      "actor": {
        "email": "user@example.com",
        "id": "000000000000000000000008",
        "name": "Session User m23-nested-gus"
      },
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [],
        "group": "Engineering",
        "groupId": "000000000000000000000009",
        "included": [
          {
            "groupId": "000000000000000000000010",
            "name": "Backend"
          }
        ],
        "reached": 2,
        "via": "app",
        "workspaceId": "000000000000000000000011"
      },
      "id": "000000000000000000000014",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    },
    {
      "action": "enterprise_group_updated",
      "actor": {
        "email": "user@example.com",
        "id": "000000000000000000000008",
        "name": "Session User m23-nested-gus"
      },
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [
          {
            "groupId": "000000000000000000000010",
            "name": "Backend"
          }
        ],
        "group": "Engineering",
        "groupId": "000000000000000000000009",
        "included": [],
        "reached": 2,
        "via": "app",
        "workspaceId": "000000000000000000000011"
      },
      "id": "000000000000000000000015",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    },
    {
      "action": "enterprise_group_updated",
      "actor": {
        "email": "user@example.com",
        "id": "000000000000000000000008",
        "name": "Session User m23-nested-gus"
      },
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["workspaces"],
        "enterpriseId": "000000000000000000000001",
        "group": "Engineering",
        "groupId": "000000000000000000000009",
        "reached": 2,
        "via": "app",
        "workspaceId": "000000000000000000000011"
      },
      "id": "000000000000000000000016",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    },
    {
      "action": "enterprise_group_updated",
      "actor": {
        "email": "user@example.com",
        "id": "000000000000000000000017",
        "name": "Session User m23-nested-ada"
      },
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [
          {
            "groupId": "000000000000000000000010",
            "name": "Backend"
          }
        ],
        "group": "Security reviewers",
        "groupId": "000000000000000000000003",
        "included": [],
        "reached": 2,
        "stepUp": {
          "at": "2026-01-01T00:00:00.000Z",
          "method": "passkey"
        },
        "via": "app",
        "workspaceId": "000000000000000000000011"
      },
      "id": "000000000000000000000018",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    },
    {
      "action": "enterprise_group_updated",
      "actor": {
        "email": "user@example.com",
        "id": "000000000000000000000017",
        "name": "Session User m23-nested-ada"
      },
      "at": "2026-01-01T00:00:00.000Z",
      "details": {
        "changed": ["includes"],
        "enterpriseId": "000000000000000000000001",
        "excluded": [],
        "group": "Security reviewers",
        "groupId": "000000000000000000000003",
        "included": [
          {
            "groupId": "000000000000000000000010",
            "name": "Backend"
          }
        ],
        "reached": 2,
        "stepUp": {
          "at": "2026-01-01T00:00:00.000Z",
          "method": "passkey"
        },
        "via": "app",
        "workspaceId": "000000000000000000000011"
      },
      "id": "000000000000000000000019",
      "ip": "127.0.0.1",
      "userAgent": "undefined"
    }
  ],
  "nextCursor": null
}
```

### 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.audit.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
