---
title: "Get BackgroundJobs"
method: GET
path: "/api/v2/ui/backgroundJobs/{id}"
tags: ["BackgroundJobs"]
---

# Get BackgroundJobs

`GET /api/v2/ui/backgroundJobs/{id}`

## Request

- Base URL: `https://docs.hashtopolis.org`
- URL: `https://docs.hashtopolis.org/api/v2/ui/backgroundJobs/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hashtopolis/apis/hashtopolis-api/docs/api/v2/ui/backgroundJobs/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

GET request to retrieve a single object.

## Path parameters

- `id` integer, required

## Query parameters

- `include` string[]

## Response `200`

successful operation

- BackgroundJobResponse
  - `jsonapi` object, required
    - `version` string, required
    - `ext` string[]
  - `links` object, required
    - `self` string, required
  - `data` object, required
    - `id` integer, required
    - `type` 'backgroundJob', required
    - `attributes` object, required
      - `jobType` string, required
      - `payload` object, required
      - `status` union, required
        - -1
        - 0
        - 1
        - 2
      - `userId` integer, nullable, required
      - `createdAt` integer, required
      - `startedAt` integer, nullable, required
      - `finishedAt` integer, nullable, required
      - `exitCode` integer, nullable, required
      - `resultMessage` string, nullable, required
    - `links` object, required
      - `self` string, required
    - `relationships` object, required
      - `user` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'user', required
          - `id` integer, required
  - `included` object[]
    - `id` integer, required
    - `type` 'user', required
    - `attributes` object, required
      - `name` string, required
      - `email` string
      - `isValid` boolean
      - `isComputedPassword` boolean
      - `lastLoginDate` integer
      - `registeredSince` integer
      - `sessionLifetime` integer
      - `globalPermissionGroupId` integer

## Other responses

- `400`: Invalid request
- `401`: Authentication failed
- `403`: Permission denied
- `404`: Not Found

## Changes

- **2026-10-22** `559b0274a0c8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hashtopolis/apis/hashtopolis-api/changes/api/v2/ui/backgroundJobs/:id/get.md)

---

[API](https://skmtc.dev/hashtopolis/apis/hashtopolis-api.md) - [All operations](https://skmtc.dev/hashtopolis/apis/hashtopolis-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hashtopolis/apis/hashtopolis-api/revisions/87f3bd43387f?raw)