List Admin Jobs

GET

/admin/jobs/

const url = 'https://example.com/admin/jobs/?skip=0&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/admin/jobs/?skip=0&limit=50' \
  --header 'Authorization: Bearer <token>'

List all ingestion jobs with optional status/user/search filters (admin only).

Authorizations

Parameters

Query Parameters

status

Any of:

string
null

string

user_id

Any of:

string
null

string format: uuid

search

Any of:

string
null

string

skip

Skip

integer

limit

Limit

integer

default: 50 >= 1 <= 200

Responses

200

Successful Response

application/json

AdminJobListResponse

object

jobs

required

Jobs

Page of ingestion jobs.

Array<object>

AdminJobResponse

object

can_retry

required

Can Retry

Whether the failed job can be retried with its retained source.

boolean

completed_at

required

Any of:

string
null

string format: date-time

created_at

required

Created At

Timestamp when the job was queued.

string format: date-time

created_by

required

Any of:

string
null

string format: uuid

dataset_id

required

Any of:

string
null

string format: uuid

error_message

required

Any of:

string
null

string

required

Unique ingestion job identifier.

string format: uuid

retry_reason

required

Any of:

string
null

string

source_filename

required

Any of:

string
null

string

started_at

required

Any of:

string
null

string format: date-time

status

required

Status

Current job status: ‘pending’, ‘running’, ‘complete’, ‘failed’, or ‘cancelled’.

string

Allowed values: pending running complete failed cancelled fanned_out

user_metadata

required

Any of:

object
null

object

key

additional properties

any

username

required

Any of:

string
null

string

total

required

Total

Total number of jobs matching the query.

integer

Example

{
  "jobs": [
    {
      "status": "pending"
    }
  ]
}

400

Bad request — invalid query parameters or payload

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Forbidden — caller lacks access to this resource

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}