Jelliu API documentation

curl -G https://api.jelliu.co/api/audit \
     -H "Authorization: Bearer <token>" \
     -d limit=100 \
     -d offset=100 \
     -d resourceId=5d2f8a4c-1b3e-4f6a-9c7d-8e0f1a2b3c4d \
     -d resourceType=outbound_webhook \
     --data-urlencode userId=apikey:4f1e2d3c-5b6a-4978-8a9b-0c1d2e3f4a5b

{
  "data": [
    {
      "id": "5b0f3c1e-8d2a-4b7e-9f61-2c4d8a9e7b10",
      "tenant_id": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "user_id": "user_2kLmNoPqRsTuVwXyZ",
      "action": "webhook.update",
      "resource_type": "outbound_webhook",
      "resource_id": "5d2f8a4c-1b3e-4f6a-9c7d-8e0f1a2b3c4d",
      "ip_address": "181.49.12.7",
      "user_agent": {
        "browser": "Chrome",
        "os": "Windows",
        "device": "desktop"
      },
      "created_at": "2026-09-14T13:22:05.114Z"
    },
    {
      "id": "2e7a9c4b-1d3f-4a6e-8b0c-5f7d9e1a3c6b",
      "tenant_id": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "user_id": "apikey:4f1e2d3c-5b6a-4978-8a9b-0c1d2e3f4a5b",
      "action": "FAILED_MUTATION:webhook.create",
      "resource_type": "outbound_webhook",
      "resource_id": null,
      "ip_address": "34.82.101.16",
      "user_agent": {
        "browser": "Unknown",
        "os": "Unknown",
        "device": "bot"
      },
      "created_at": "2026-09-14T12:58:41.702Z"
    }
  ]
}

Returns the workspace’s audit trail, newest first. Filter by resource type, resource id or user id; the filters combine with AND. Each row says who (user_id) did what (action) to which resource, from which IP and client, and when. Rejected attempts appear with a FAILED_MUTATION: or FAILED_READ: prefix on action.

List rows leave out the request body (changes) and the integrity fields; fetch GET /api/audit/{id} for those. To check that the log was not tampered with, use GET /api/audit/verify-chain.

Uses offset pagination with limit and offset. The response has no total and no cursor: keep requesting pages until one comes back with fewer than limit rows. See Pagination. For a full copy, an audit_log export (POST /api/exports) is cheaper than paging.

Idempotency. A read with no side effects, and not itself written to the audit log. Safe to retry.

Access

Required scope: full. Human users need the owner role; admins are refused.
Rate limit: Audit — 20 requests/min per workspace, shared with the other audit routes, plus the general API limit (120–600/min by plan). The audit limiter counts a request even when the role check then refuses it. See Rate limits.
Plan: Available on every plan.

Returns the workspace's audit trail, newest first. Filter by resource type, resource id or user id; the filters combine with AND. Each row says who (`user_id`) did what (`action`) to which resource, from which IP and client, and when. Rejected attempts appear with a `FAILED_MUTATION:` or `FAILED_READ:` prefix on `action`. List rows leave out the request body (`changes`) and the integrity fields; fetch `GET /api/audit/{id}` for those. To check that the log was not tampered with, use `GET /api/audit/verify-chain`. Uses offset pagination with `limit` and `offset`. The response has no total and no cursor: keep requesting pages until one comes back with fewer than `limit` rows. See [Pagination](/pagination). For a full copy, an `audit_log` export (`POST /api/exports`) is cheaper than paging. **Idempotency.** A read with no side effects, and not itself written to the audit log. Safe to retry. **Access** - **Required scope:** `full`. Human users need the **owner** role; admins are refused. - **Rate limit:** Audit — 20 requests/min per workspace, shared with the other audit routes, plus the general API limit (120–600/min by plan). The audit limiter counts a request even when the role check then refuses it. See [Rate limits](/rate-limits). - **Plan:** Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

Scope	GET / HEAD	POST / PUT / PATCH / DELETE	Admin-only routes
`read`	Yes	No	No
`write`	Yes	Yes	No
`full`	Yes	Yes	Yes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Workspace API key: `jl_` followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (**Settings → API Keys**) and sent as `Authorization: Bearer jl_...`. The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | Operations restricted to admins or owners reject keys without the `full` scope with `403`, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See [Authentication](/authentication).

Query parameters

resourceTypestringOptional<=100 characters

Exact match on resource_type, for example agent, campaign, outbound_webhook, export, report, integration or contact. Longer than 100 characters answers 400.

resourceIdstringOptionalformat: "uuid"

Exact match on resource_id. Must be a UUID or the request fails with 400. Resources with non-UUID ids have no resource_id; their id is kept in changes._resource_ref.

userIdstringOptional<=200 characters

Exact match on user_id. A dashboard user id (user_…), or apikey:<keyId> for requests made with an API key. Up to 200 characters.

limitintegerOptional1-100Defaults to 50

Page size, 1 to 100. Out-of-range or non-numeric values silently fall back to 50 (not to the nearest bound).

offsetintegerOptional>=0Defaults to 0

Rows to skip. Negative or non-numeric values silently fall back to 0.

Response

Audit entries, newest first.

datalist of objects

Rows ordered by created_at descending.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

List rows leave out the request body (changes) and the integrity fields; fetch GET /api/audit/{id} for those. To check that the log was not tampered with, use GET /api/audit/verify-chain.

Idempotency. A read with no side effects, and not itself written to the audit log. Safe to retry.

Access

Required scope: full. Human users need the owner role; admins are refused.
Rate limit: Audit — 20 requests/min per workspace, shared with the other audit routes, plus the general API limit (120–600/min by plan). The audit limiter counts a request even when the role check then refuses it. See Rate limits.
Plan: Available on every plan.