Jelliu API documentation

{
  "data": {
    "id": "3d9f1b2a-6c4e-4f8a-9b1d-2e7c5a0f8d13",
    "tenant_id": "8a41c7e2-3b5d-4f09-a6e1-7d2c9b0f4e58",
    "provider": "kommo",
    "label": "Kommo ventas Bogotá",
    "auth_method": "oauth2",
    "status": "active",
    "credentials": "***",
    "contact_count": 0,
    "last_synced_at": null,
    "last_error": null,
    "field_mapping": {},
    "campaign_id": null,
    "oauth_expires_at": "2026-09-16T02:14:09.000Z",
    "oauth_scopes": null,
    "inbound_webhook_uuid": "5b2e8c71-0d4a-4e93-b6f2-9a1c3d7e0b44",
    "created_at": "2026-09-02T14:21:37.000Z",
    "updated_at": "2026-09-15T02:14:09.000Z",
    "deleted_at": null,
    "webhook_secret": null,
    "external_account_id": "31849022",
    "sync_cursor": null,
    "ticketing_config": {},
    "oauth_metadata": {
      "scopes_verified": true,
      "subdomain": "miempresa"
    },
    "oauth_access_token": "v3:4f1a9c2e7b3d...(ciphertext, truncated)",
    "oauth_refresh_token": "v3:a07e5d1c93f2...(ciphertext, truncated)",
    "discovered_schema": {}
  }
}

Returns the full integration record, including columns the list omits: webhook_secret, external_account_id, oauth_metadata, discovered_schema and the stored OAuth tokens as encrypted ciphertext. credentials is always ***.

Consistency. Cached for up to 5 minutes; every write through this API, the OAuth callback and token refreshes clear the cache.

Access

Required scope: read (or write). Any workspace member can call it.
Rate limit: General API — 120 to 600 requests/min per workspace depending on plan. See Rate limits.
Plan: Available on every plan.

Returns the full integration record, including columns the list omits: `webhook_secret`, `external_account_id`, `oauth_metadata`, `discovered_schema` and the stored OAuth tokens as encrypted ciphertext. `credentials` is always `***`. **Consistency.** Cached for up to 5 minutes; every write through this API, the OAuth callback and token refreshes clear the cache. **Access** - **Required scope:** `read` (or `write`). Any workspace member can call it. - **Rate limit:** General API — 120 to 600 requests/min per workspace depending on plan. 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).

Path parameters

integrationIdstringRequiredformat: "uuid"

Integration id from GET /api/integrations. A value that is not a UUID is rejected with 400.

Response

The integration.

dataobject

The full integration record returned by retrieve, create and update: every Integration field plus the columns below. credentials is still masked; OAuth tokens appear only as encrypted ciphertext.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

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