Skip to main content

List Jobs

GET 
/jobs

Returns a paginated list of jobs with optional filtering and sorting.

Filtering​

Filter jobs using query parameters:

  • types: Filter by job type (pipeline, query, update, config)
  • states: Filter by job state (pending, running, stopped, etc.)
  • labels: Label selector for matching jobs (e.g., "env=prod,region=us-west")
  • namespace: Filter by namespace (if multi-tenant)

Pagination​

  1. First request: Specify limit (default 50, max 1000)
  2. Response includes next_token if more results available
  3. Subsequent requests: Include next_token from previous response
  4. Continue until next_token is empty

Sorting​

  • order_by: Field to sort by (created_at, updated_at, name)
  • order: Sort direction (asc or desc)
  • Default: created_at desc (newest first)

Common Patterns​

  • All running jobs: ?states=running
  • Production pipelines: ?types=pipeline&labels=env=production
  • Recently updated: ?order_by=updated_at&order=desc&limit=10

Request​

Responses​

OK