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

# List Crawler Jobs

> Lists crawler jobs for a workspace using the V3 API.

## Overview

Returns paginated crawler jobs for the selected workspace.

## Includes

* Job status
* Page counts
* Estimated credits
* Per-page billing rate
* Webhook summary configuration

<Tip>
  Use the `page` and `limit` query parameters to paginate through large job histories.
</Tip>


## OpenAPI

````yaml GET /workspaces/{workspaceId}/crawler/jobs
openapi: 3.0.3
info:
  title: Convocore OpenAPI
  description: Full API reference for Convocore
  version: 1.0.4
servers:
  - url: https://eu-gcp-api.vg-stuff.com/v3
security: []
paths:
  /workspaces/{workspaceId}/crawler/jobs:
    get:
      tags:
        - Crawler
      summary: List crawler jobs
      description: >-
        Returns crawler jobs for the authenticated workspace. Crawler jobs are
        immutable after submission; use delete to remove a job instead of trying
        to update it.
      operationId: listCrawlerJobs
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: includeTotal
          in: query
          required: false
          schema:
            type: boolean
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 2048
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      jobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/object_e29c2fd2'
                      total:
                        type: number
                        nullable: true
                      pageSize:
                        type: number
                      hasMore:
                        type: boolean
                      nextCursor:
                        type: string
                        nullable: true
                    required:
                      - jobs
                      - total
                      - pageSize
                      - hasMore
                      - nextCursor
                    additionalProperties: false
                required:
                  - success
                  - message
                  - data
                additionalProperties: false
        default:
          $ref: '#/components/responses/error'
      security:
        - Authorization: []
components:
  schemas:
    object_e29c2fd2:
      type: object
      properties:
        id:
          type: string
        workspaceId:
          type: string
        status:
          $ref: '#/components/schemas/string_2c1ccf80'
        primaryUrl:
          type: string
        urls:
          type: array
          items:
            type: string
        crawl:
          type: boolean
        crawlOptions:
          $ref: >-
            #/components/schemas/maxPages_urlMatchers_unMatchers_stayOnDomain_b95006
        useProxy:
          type: boolean
        aiPostProcess:
          type: boolean
        deep:
          type: boolean
        mode:
          type: string
          enum:
            - markdown
            - schema
        schemaCrawl:
          $ref: '#/components/schemas/object_fc2128c8'
        refreshRate:
          type: string
          nullable: true
        toAgentId:
          type: string
          nullable: true
        toAgentIds:
          type: array
          items:
            type: string
        done:
          type: boolean
        failed:
          type: boolean
        isCancelled:
          type: boolean
        message:
          type: string
          nullable: true
        resultError:
          type: string
          nullable: true
        createdAt:
          type: string
          nullable: true
        ts:
          type: number
        currentPageIndex:
          type: number
        scrapedPagesNum:
          type: number
        failedPagesNum:
          type: number
        pageLimit:
          type: number
        creditsPerPage:
          type: number
        estimatedCredits:
          type: number
        activeScrapeUrl:
          type: string
          nullable: true
        crawlerJobId:
          type: string
          nullable: true
        webhook:
          $ref: '#/components/schemas/url_events_hasSecret_hasBearerToken_e213dd'
      required:
        - id
        - workspaceId
        - status
        - primaryUrl
        - urls
        - crawl
        - crawlOptions
        - useProxy
        - deep
        - refreshRate
        - toAgentId
        - toAgentIds
        - done
        - failed
        - isCancelled
        - message
        - resultError
        - createdAt
        - ts
        - currentPageIndex
        - scrapedPagesNum
        - failedPagesNum
        - pageLimit
        - creditsPerPage
        - estimatedCredits
        - activeScrapeUrl
        - crawlerJobId
      additionalProperties: false
    string_2c1ccf80:
      type: string
      enum:
        - queued
        - processing
        - completed
        - failed
        - cancelled
    maxPages_urlMatchers_unMatchers_stayOnDomain_b95006:
      type: object
      properties:
        maxPages:
          $ref: '#/components/schemas/integer_61bce812'
        urlMatchers:
          $ref: '#/components/schemas/array_33ac78ec'
        unMatchers:
          $ref: '#/components/schemas/array_e9b67bd5'
        stayOnDomain:
          type: boolean
          description: If true, only pages on the same domain are crawled.
      additionalProperties: false
      nullable: true
    object_fc2128c8:
      type: object
      properties:
        phase:
          type: string
        maxItems:
          type: number
        discoveredCount:
          type: number
        extractedCount:
          type: number
        entityName:
          type: string
          nullable: true
        fieldCount:
          type: number
        pageCreditsUsed:
          type: number
        llmCreditsUsed:
          type: number
        totalCreditsUsed:
          type: number
        resultPath:
          type: string
          nullable: true
        lastDiscoveryReason:
          type: string
          nullable: true
      additionalProperties: false
      nullable: true
    url_events_hasSecret_hasBearerToken_e213dd:
      type: object
      properties:
        url:
          type: string
          format: uri
        events:
          $ref: '#/components/schemas/array_8ed97274'
        hasSecret:
          type: boolean
        hasBearerToken:
          type: boolean
        headerKeys:
          type: array
          items:
            type: string
      required:
        - url
        - events
        - hasSecret
        - hasBearerToken
        - headerKeys
      additionalProperties: false
    message_11569e:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      additionalProperties: false
    integer_61bce812:
      type: integer
      minimum: 1
      maximum: 500
      description: Maximum number of pages the crawler is allowed to process.
    array_33ac78ec:
      type: array
      items:
        type: string
      description: URL path matchers that define which pages are in scope.
    array_e9b67bd5:
      type: array
      items:
        type: string
      description: URL path matchers that should be excluded.
    array_8ed97274:
      type: array
      items:
        type: string
        enum:
          - page_scraped
          - job_completed
          - job_failed
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  $ref: '#/components/schemas/message_11569e'
            required:
              - message
              - code
            additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````