> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pomerado.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List jobs

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

<Accordion title="Details">
  * 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}.

  * **Callers:** an API key, an integration's API key, an MCP OAuth token or a Dashboard session.

  * **Permission:** `jobs:read`.

  * **Effect:** Changes nothing.

  * **Errors:** only the [errors any request can get](/errors).
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json get /v1/jobs
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: code
    x-group: Code
  - name: logins
    x-group: Saved logins
  - name: two_factor
    x-group: 2FA
  - name: login_access
    x-group: Login access
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: files
    x-group: Files
  - name: team
    x-group: Team
paths:
  /v1/jobs:
    get:
      tags:
        - jobs
      summary: List jobs
      description: >-
        List your runs and builds, newest first, each with its status, website,
        task and the question it asks.
      operationId: jobs.list
      parameters:
        - name: type
          in: query
          required: false
          description: Only runs, or only builds
          schema:
            type: string
            enum:
              - run
              - build
        - name: status
          in: query
          required: false
          description: >-
            Only jobs in these statuses, comma-separated: queued, running,
            needs_input, succeeded, failed, cancelled
          schema:
            type: string
        - name: q
          in: query
          required: false
          description: >-
            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
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: The next_cursor of the previous page
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Jobs per page, 1 to 50 (default 20)
          schema:
            type: string
      responses:
        '200':
          description: One page of jobs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobList'
        '400':
          description: invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    JobList:
      type: object
      required:
        - data
        - next_cursor
        - needs_input_count
        - counts
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
        needs_input_count:
          $ref: '#/components/schemas/Int'
          description: counts.needs_input, kept for callers that read it
          minimum: 0
        counts:
          $ref: '#/components/schemas/JobCounts'
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
    JobSummary:
      type: object
      required:
        - id
        - type
        - build_kind
        - status
        - stage
        - site_url
        - site_name
        - task
        - question
        - waiting_since
        - tool_id
        - tool_name
        - integration_id
        - eta
        - watch_url
        - created_at
        - updated_at
        - completed_at
      properties:
        id:
          $ref: '#/components/schemas/job_id'
        type:
          type: string
          enum:
            - run
            - build
        build_kind:
          anyOf:
            - type: string
              enum:
                - new
                - change
            - type: 'null'
          description: >-
            A build of a new tool, or a requested change to an existing one;
            null for a run
        status:
          type: string
          enum:
            - queued
            - running
            - needs_input
            - succeeded
            - failed
            - cancelled
        stage:
          anyOf:
            - type: string
              enum:
                - queued
                - checking_login
                - exploring
                - building
                - publishing
            - type: 'null'
          description: A build's current stage, or the one it ended in; null for a run
        site_url:
          anyOf:
            - type: string
            - type: 'null'
          description: The website's https origin the job was asked for
        site_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The site's name: its tool's integration's, else the integration of
            its website; null until one names it
        task:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            A build's task or a requested change, its first 500 characters; GET
            /v1/jobs/{id} shows all of it. Null for a run
        question:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The first question's prompt while the job asks one; answer it with
            GET /v1/jobs/{id}'s input_request
        waiting_since:
          anyOf:
            - type: string
            - type: 'null'
          description: When the question was asked, while the job asks one
        tool_id:
          anyOf:
            - type: string
            - type: 'null'
        tool_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The name of the tool tool_id names, such as the one a build
            published
        integration_id:
          anyOf:
            - $ref: '#/components/schemas/integration_id'
            - type: 'null'
        eta:
          anyOf:
            - type: object
              required:
                - min_seconds
                - max_seconds
              properties:
                min_seconds:
                  type: number
                max_seconds:
                  type: number
              additionalProperties: false
            - type: 'null'
          description: >-
            How long builds usually take, in seconds from start to end, while
            this one is queued or running; null otherwise
        watch_url:
          type: string
        created_at:
          $ref: '#/components/schemas/Date'
        updated_at:
          $ref: '#/components/schemas/Date'
        completed_at:
          anyOf:
            - $ref: '#/components/schemas/Date'
            - type: 'null'
      additionalProperties: false
    Int:
      type: integer
      description: an integer
    JobCounts:
      type: object
      required:
        - needs_input
        - in_progress
        - finished
      properties:
        needs_input:
          $ref: '#/components/schemas/Int'
          description: Waiting on an answer now (at most 100)
          minimum: 0
        in_progress:
          $ref: '#/components/schemas/Int'
          description: Queued or running (at most 100)
          minimum: 0
        finished:
          $ref: '#/components/schemas/Int'
          description: Succeeded, failed or cancelled (at most 1000)
          minimum: 0
      additionalProperties: false
      description: >-
        How many of your jobs of the listed type are in each state, whatever
        status, q, cursor and limit asked for
    job_id:
      type: string
      description: 'a job ID: job_ and 32 lowercase hex digits'
      examples:
        - job_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
    integration_id:
      type: string
      description: 'an integration ID: int_ and 32 lowercase hex digits'
      examples:
        - int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
    Date:
      type: string
      description: a string to be decoded into a Date
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.