jobs

List jobs

List your runs and builds, newest first, each with its status, website, task and the question it asks.

  • Lists the jobs you can read with GET /v1/jobs/{id}: those your API key, app or Dashboard started. The Dashboard lists the ones you started from any client.
  • status filters by one or more statuses, comma-separated, such as status=needs_input. A filtered page can hold fewer jobs than limit, so follow next_cursor until it is null.
  • q finds the jobs whose website or site name contains its text. Tasks are kept encrypted for you alone and can't be searched here; search them in the jobs you list.
  • counts totals your jobs of the listed type by state, whatever status, q, cursor and limit asked for; needs_input_count repeats counts.needs_input.
  • A job's result is never listed; read it with GET /v1/jobs/{id}.
get/v1/jobs

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/jobs
  • Auth: HTTP bearer

Query parameters

type'run' | 'build'

Only runs, or only builds

statusstring

Only jobs in these statuses, comma-separated: queued, running, needs_input, succeeded, failed, cancelled

qstring

Only jobs whose website or site name contains this text, ignoring case. A task is kept encrypted for you alone, so search tasks in the jobs you have listed

cursorstring

The next_cursor of the previous page

limitstring

Jobs per page, 1 to 50 (default 20)

Response

One page of jobs

next_cursorstring nullable required
needs_input_countinteger required

an integer

Example response

{
  "data": [
    {
      "id": "job_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
      "integration_id": "int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.