Jobs

Endpointhttps://api.kontier.eu/v1

Background jobs of your workspace (exports, imports, sends, …) and their runs. Read-only. Events such as jobs.dead_lettered carry a job_id you can look up here.

List your organization's background jobs

GET

https://api.kontier.eu/v1

/jobs

Keyset-paginated list of the calling organization's durable background jobs. Requires the job.read permission.

List your organization's background jobs › query Parameters

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

Opaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.

topic

array | null · explode: true

Filter by topic. Repeatable or comma-separated.

status

array | null · explode: true

archived

boolean

Read the archive table instead of the live jobs table

List your organization's background jobs › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List your organization's background jobs › Responses

array | null · required

object · required

GET/jobs

curl --request GET \
  --url https://api.kontier.eu/v1/jobs

shell

Example Responses

{
  "data": [
    {
      "attempts": 0,
      "correlation_id": "correlation_id",
      "created_at": "2024-08-25T15:00:00Z",
      "deferrals": 0,
      "deferred_detail": "deferred_detail",
      "deferred_reason": "organization_held",
      "due_at": "2024-08-25T15:00:00Z",
      "error_class": "error_class",
      "error_code": "error_code",
      "error_details": {},
      "error_message": "error_message",
      "finished_at": "2024-08-25T15:00:00Z",
      "heartbeat_at": "2024-08-25T15:00:00Z",
      "id": "id",
      "leased_until": "2024-08-25T15:00:00Z",
      "max_attempts": 0,
      "not_before": "2024-08-25T15:00:00Z",
      "organization_id": "organization_id",
      "paused_at": "2024-08-25T15:00:00Z",
      "payload": {},
      "picked_by": "picked_by",
      "priority": 0,
      "ready_at": "2024-08-25T15:00:00Z",
      "result": {},
      "started_at": "2024-08-25T15:00:00Z",
      "status": "blocked",
      "time_domain": "00000000-0000-0000-0000-000000000000",
      "topic": "topic",
      "updated_at": "2024-08-25T15:00:00Z",
      "version": 0,
      "workspace_id": "workspace_id"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Get one of your organization's background jobs

GET

https://api.kontier.eu/v1

/jobs/{jobID}

Returns a single durable job by id (organization-scoped). Requires the job.read permission.

Get one of your organization's background jobs › path Parameters

jobID

string · uuid · required

Job id (UUID)

Get one of your organization's background jobs › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get one of your organization's background jobs › Responses

object · required

GET/jobs/{jobID}

curl --request GET \
  --url https://api.kontier.eu/v1/jobs/:jobID

shell

Example Responses

{
  "data": {
    "attempts": 0,
    "correlation_id": "correlation_id",
    "created_at": "2024-08-25T15:00:00Z",
    "deferrals": 0,
    "deferred_detail": "deferred_detail",
    "deferred_reason": "organization_held",
    "due_at": "2024-08-25T15:00:00Z",
    "error_class": "error_class",
    "error_code": "error_code",
    "error_details": {},
    "error_message": "error_message",
    "finished_at": "2024-08-25T15:00:00Z",
    "heartbeat_at": "2024-08-25T15:00:00Z",
    "id": "id",
    "leased_until": "2024-08-25T15:00:00Z",
    "max_attempts": 0,
    "not_before": "2024-08-25T15:00:00Z",
    "organization_id": "organization_id",
    "paused_at": "2024-08-25T15:00:00Z",
    "payload": {},
    "picked_by": "picked_by",
    "priority": 0,
    "ready_at": "2024-08-25T15:00:00Z",
    "result": {},
    "started_at": "2024-08-25T15:00:00Z",
    "status": "blocked",
    "time_domain": "00000000-0000-0000-0000-000000000000",
    "topic": "topic",
    "updated_at": "2024-08-25T15:00:00Z",
    "version": 0,
    "workspace_id": "workspace_id"
  }
}

json

application/json

List a job's attempt history

GET

https://api.kontier.eu/v1

/jobs/{jobID}/runs

The durable per-attempt audit trail (live + archived runs) for one of your organization's jobs. Requires the job.read permission.

List a job's attempt history › path Parameters

jobID

string · uuid · required

Job id (UUID)

List a job's attempt history › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List a job's attempt history › Responses

array | null · required

object · required

GET/jobs/{jobID}/runs

curl --request GET \
  --url https://api.kontier.eu/v1/jobs/:jobID/runs

shell

Example Responses

{
  "data": [
    {
      "attempt": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "deferred_detail": "deferred_detail",
      "deferred_reason": "organization_held",
      "error_class": "error_class",
      "error_code": "error_code",
      "error_details": {},
      "error_message": "error_message",
      "finished_at": "2024-08-25T15:00:00Z",
      "id": "id",
      "job_id": "job_id",
      "started_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Approvals Organization Settings

List your organization's background jobs

GET

https://api.kontier.eu/v1

/jobs

Keyset-paginated list of the calling organization's durable background jobs. Requires the job.read permission.

List your organization's background jobs › query Parameters

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

topic

array | null · explode: true

Filter by topic. Repeatable or comma-separated.

status

array | null · explode: true

archived

boolean

Read the archive table instead of the live jobs table

List your organization's background jobs › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List your organization's background jobs › Responses

array | null · required

object · required

Get one of your organization's background jobs

GET

https://api.kontier.eu/v1

/jobs/{jobID}

Returns a single durable job by id (organization-scoped). Requires the job.read permission.

Get one of your organization's background jobs › path Parameters

jobID

string · uuid · required

Job id (UUID)

Get one of your organization's background jobs › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get one of your organization's background jobs › Responses

object · required

List a job's attempt history

GET

https://api.kontier.eu/v1

/jobs/{jobID}/runs

The durable per-attempt audit trail (live + archived runs) for one of your organization's jobs. Requires the job.read permission.

List a job's attempt history › path Parameters

jobID

string · uuid · required

Job id (UUID)

List a job's attempt history › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List a job's attempt history › Responses

array | null · required

object · required