---
title: "Get a job by ID"
method: GET
path: "/jobs/{jobId}"
---

# Get a job by ID

`GET /jobs/{jobId}`

Get details about a running or completed job by job ID.

## Path parameters

- `jobId` string, required

## Query parameters

- `api-version` string, required

## Response `200`

Success

- Job — The job definition.
  - `id` string — Unique ID of the job.
  - `scheduledJobId` string — Id of the scheduled job definition that created this job.
  - `displayName` string — Display name of the job.
  - `description` string — Detailed description of the job.
  - `group` string, required — The ID of the device group on which to execute the job.
  - `batch` JobBatch — The job batch definition.
    - `type` 'number' | 'percentage', required — Whether batching is done on a specified number of devices or a percentage of the total devices.
    - `value` number, required — The number or percentage of devices on which batching is done.
  - `cancellationThreshold` JobCancellationThreshold — The job cancellation threshold definition.
    - `type` 'number' | 'percentage', required — Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices.
    - `value` number, required — The number or percentage of devices on which the cancellation threshold is applied.
    - `batch` boolean — Whether the cancellation threshold applies per-batch or to the overall job.
  - `data` JobData[], required — The capabilities being updated by the job and the values with which they are being updated.
    - `type` string, required — Type of the job data.
  - `start` string, date-time — The start time of the job
  - `end` string, date-time — The end time of the job
  - `progress` JobProgress — progress summary for a scheduled job.
    - `total` integer — The total number of entities targeted by the job.
    - `pending` integer — The number of entities for which the job is not yet running.
    - `completed` integer — The number of entities for which the job has completed.
    - `failed` integer — The number of entities for which the job has failed.
  - `status` string — Indicates whether the job is starting, running, etc.
  - `organizations` string[] — List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.

## Other responses

- `default` — An error response received from the IoT Central Service.

---

[API](https://skmtc.net/azure/apis/iotcentral-iotcentral.md) · [All operations](https://skmtc.net/azure/apis/iotcentral-iotcentral/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/iotcentral-iotcentral/revisions/565d8813cbd3/schema)