---
title: "List jobs"
method: GET
path: "/v1/jobs"
tags: ["jobs"]
---

# List jobs

`GET /v1/jobs`

## Request

- Base URL: `https://api.niubai.vip` (the document declares no server; this is the origin it was published from)
- URL: `https://api.niubai.vip/v1/jobs`
- Auth: HTTP bearer

The account's jobs, newest first, with status, kind, timings, pages billed and the number of changes. Filter with `since` and `status`; page with `cursor` and `limit`. Kept 30 days.

## Query parameters

- `since` string, date-time, nullable: ISO 8601 lower bound on created_at
- `status` string, nullable
- `cursor` string, nullable: the job_id of the last row of the previous page
- `limit` integer

## Response `200`

Successful Response

- JobListOut
  - `jobs` JobSummaryOut[], required
    - `job_id` string, required
    - `kind` string, required
    - `status` string, required
    - `created_at` string, nullable
    - `finished_at` string, nullable
    - `pages_billed` integer
    - `changes` integer
    - `warnings` string[]
    - `error_code` string, nullable
    - `webhook_state` string, nullable
  - `next_cursor` string, nullable: Pass as `cursor` for the next page; null on the last.

## Other responses

- `400`: error.code is one of: invalid_request
- `401`: error.code is one of: unauthorized
- `429`: error.code is one of: rate_limited

---

[API](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway.md) · [All operations](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway/revisions/83ed2bb54eb5?raw)