Skip to navigation

Retrieve an export job

View as Markdown

Returns one export job. Poll this endpoint after POST /api/exports until status is completed (then call GET /api/exports/{id}/download) or failed (read error). Every few seconds is enough; most exports finish in seconds, and very large ones can take a few minutes.

A job that fails is retried once about 10 seconds later, so failed can briefly turn back into processing. Treat failed as final once it has not changed for a minute.

Consistency. Not cached: it always reflects the latest job state.

Idempotency. A read with no side effects. Safe to retry.

Access

  • Required scope: read or write. Jobs of type audit_log or agent_actions need full, and human users need the owner or admin role for them.
  • Rate limit: General API — 120 requests/min per workspace on Starter or with no active plan, 200 on Growth, 300 on Business, 600 on Enterprise. See 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.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

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.

Path parameters

idstringRequiredformat: "uuid"

UUID of the export job, as returned in data.id by POST /api/exports. A job of another workspace answers 404.

Response

The export job.
dataobject

An asynchronous export job, as stored (snake_case). Created by POST /api/exports.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error