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

# Get a job

> Returns the status of a background job that an earlier request started in this building.

Some requests finish in the background. They answer `202` with a job, and you read the job here until it ends. The requests that start a job are:

* [Ingest devices through a connector](https://docs.kodelabs.com/products/kode-api/api-reference/connectors/ingest-devices-through-a-connector.md)
* [Ingest points through a connector](https://docs.kodelabs.com/products/kode-api/api-reference/connectors/ingest-points-through-a-connector.md)
* The device and point batch update and batch delete requests.

Use the `_id` of the job from that response as `jobId`. Call this endpoint every few seconds until `status` is `COMPLETED` or `FAILED`. Every call counts toward your [rate limits](https://docs.kodelabs.com/products/kode-api/fundamentals.md#rate-limits).

| `status` | Meaning |
| - | - |
| `PENDING` | The job is waiting to start. |
| `PROCESSING` | The job is running. |
| `COMPLETED` | The job finished. |
| `FAILED` | The job stopped. `errorMessage` says why. |
| `CANCELED` | The job was stopped before it finished. |
| `PROCESSED` | The job is waiting for a follow-up step. Ingest jobs do not use this status. |

> [!NOTE]
>
> A job reports only its status. It has no result for each item, and `COMPLETED` means the job ran to the end. After an ingest, read the devices and points back to confirm what was stored.

A job belongs to the building that started it. Reading it under another building returns `404`.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/jobs/{jobId}
openapi: 3.1.0
info:
  title: KODE API
  version: 1.0.0
  summary: Programmatic access to KODE OS resources and operations.
  description: >
    Use the KODE API to work with buildings, data sources, connectors, devices,
    points, virtual devices,

    timeseries data, schedules, the ontology, templating, mass writes, spaces,
    space assignments, tenants, meters, users, actions,

    and AssetOps work orders.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.kodelabs.com/kodeos
    description: KODE API
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: OAuth 2.0 discovery, token, and revocation endpoints.
  - name: Buildings
    description: Buildings and their areas.
  - name: Data sources
    description: Data sources connected to a building.
  - name: Devices
    description: Devices and their points.
  - name: Points
    description: Point queries and point writes.
  - name: Timeseries
    description: Current and historical point values.
  - name: Actions
    description: Actions exposed by building data sources.
  - name: Work orders
    description: AssetOps work orders, lookups, comments, and attachments.
  - name: Connectors
    description: KODE API connectors and the devices and points ingested through them.
  - name: Schedules
    description: Schedules discovered on building data sources.
  - name: Templating
    description: Apply ontology templates to groups of points.
  - name: Virtual devices
    description: Virtual devices that group points from other devices.
  - name: Ontology
    description: Canonical types, fields, units, and connections of the KODE ontology.
  - name: Users
    description: Users of the organization and their app access.
  - name: Mass write
    description: Write values to many points across buildings, and follow each run.
  - name: Spaces
    description: Levels and space units of a building, and the meters located in them.
  - name: Space assignments
    description: Assign tenants to leasable spaces of a building for a period.
  - name: Tenants
    description: Tenants of a building, the people or companies that lease its spaces.
  - name: Meters
    description: >-
      Meters of a building, their space assignments, parent and child links, and
      readings.
paths:
  /api/v1/buildings/{buildingId}/jobs/{jobId}:
    get:
      tags:
        - Buildings
      summary: Get a job
      description: >-
        Returns the status of a background job that an earlier request started
        in this building.
      operationId: getJob
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - name: jobId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobPublic'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The building does not exist, is not available to your service
            account, or has no `api` product enabled.
        '404':
          description: No job with this id exists in this building.
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    BuildingId:
      name: buildingId
      in: path
      required: true
      description: Building identifier from List buildings.
      schema:
        type: string
      example: 67c960faffaa42223163099e
  schemas:
    JobPublic:
      type: object
      properties:
        _id:
          type: string
        organizationId:
          type: string
        createdAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        updatedAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        name:
          type: string
        description:
          type: string
        status:
          $ref: '#/components/schemas/JobStatus1'
        errorMessage:
          type: string
    Date:
      type: string
      description: >-
        Date and time in UTC, with a numeric offset and no colon, for example
        `2026-10-28T13:51:31+0000`.
      examples:
        - 2026-10-28T13:51:31+0000
    JobStatus1:
      type: string
      enum:
        - PENDING
        - PROCESSING
        - PROCESSED
        - COMPLETED
        - FAILED
        - CANCELED
  responses:
    Unauthorized:
      description: The access token is missing, invalid, or expired. Request a new token.
    TooManyRequests:
      description: >-
        A rate-limit window is exhausted. Wait, then retry with increasing
        delays.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Paste an access token from [Create an access
        token](/products/kode-api/api-reference/authentication/create-an-access-token).
        Tokens expire, so request a new one if you receive `401`.

````

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