---
title: "GET /api/jobs"
method: GET
path: "/api/jobs"
tags: ["job-controller"]
---

# GET /api/jobs

`GET /api/jobs`

## Query parameters

- `pageSize` integer, required
- `page` integer, required
- `textSearch` string
- `sortProperty` string
- `sortOrder` string
- `types` string[]
- `statuses` string[]
- `entities` string[]
- `startTime` integer
- `endTime` integer

## Response `200`

OK

- PageDataJob
  - `data` Job[] — Array of the entities
    - `id` JobId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'JOB', required — string
    - `createdTime` integer — Entity creation timestamp in milliseconds since Unix epoch
    - `tenantId` TenantId, required
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT', required — string
    - `type` 'DUMMY', required
    - `key` string, required
    - `entityId` EntityId, required
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY', required
    - `entityName` string
    - `status` 'QUEUED' | 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED', required
    - `configuration` DummyJobConfiguration, required
      - `tasksKey` string, required
      - `toReprocess` DummyTaskResult[]
        - `key` string
        - `success` boolean
        - `discarded` boolean
        - `finishTs` integer
        - `jobType` string, required
        - `failure` DummyTaskFailure
          - `error` string
          - `number` integer
          - `failAlways` boolean
      - `type` string, required
      - `taskProcessingTimeMs` integer
      - `successfulTasksCount` integer
      - `failedTasksCount` integer
      - `permanentlyFailedTasksCount` integer
      - `errors` string[]
      - `retries` integer
      - `taskProcessingTimeoutMs` integer
      - `generalError` string
      - `submittedTasksBeforeGeneralError` integer
    - `result` DummyJobResult, required
      - `successfulCount` integer
      - `failedCount` integer
      - `discardedCount` integer
      - `totalCount` integer
      - `results` DummyTaskResult[]
        - `key` string
        - `success` boolean
        - `discarded` boolean
        - `finishTs` integer
        - `jobType` string, required
        - `failure` DummyTaskFailure
          - `error` string
          - `number` integer
          - `failAlways` boolean
      - `generalError` string
      - `startTs` integer
      - `finishTs` integer
      - `cancellationTs` integer
      - `jobType` string, required
  - `totalPages` integer — Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria
  - `totalElements` integer — Total number of elements in all available pages
  - `hasNext` boolean — 'false' value indicates the end of the result set

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)