---
title: "Get Chunks"
method: GET
path: "/api/v2/ui/chunks/{id}/task"
tags: ["Chunks"]
---

# Get Chunks

`GET /api/v2/ui/chunks/{id}/task`

## Request

- Base URL: `https://docs.hashtopolis.org`
- URL: `https://docs.hashtopolis.org/api/v2/ui/chunks/{id}/task`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hashtopolis/apis/hashtopolis-api/docs/api/v2/ui/chunks/:id/task/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

## Response `200`

successful operation

- TaskResponse
  - `jsonapi` object, required
    - `version` string, required
    - `ext` string[]
  - `links` object, required
    - `self` string, required
  - `data` object, required
    - `id` integer, required
    - `type` 'task', required
    - `attributes` object, required
      - `taskName` string, required
      - `attackCmd` string, required
      - `chunkTime` integer, required
      - `statusTimer` integer, required
      - `keyspace` integer, required
      - `keyspaceProgress` integer, required
      - `priority` integer, required
      - `maxAgents` integer, required
      - `color` string, nullable, required
      - `isSmall` boolean, required
      - `isCpuTask` boolean, required
      - `useNewBench` boolean, required
      - `skipKeyspace` integer, required
      - `crackerBinaryId` integer, required
      - `crackerBinaryTypeId` integer, nullable, required
      - `taskWrapperId` integer, required
      - `isArchived` boolean, required
      - `notes` string, required
      - `staticChunks` integer, required
      - `chunkSize` integer, required
      - `forcePipe` boolean, required
      - `preprocessorId` integer, required
      - `preprocessorCommand` string, required
      - `totalAssignedAgents` integer
      - `dispatched` string
      - `searched` string
      - `status` union
        - 0
        - 1
        - 2
        - 3
        - 4
      - `totalNumberOfChunks` integer
      - `currentSpeed` integer
      - `estimatedTime` integer
      - `cprogress` integer
      - `timeSpent` integer
      - `cracked` integer
    - `links` object, required
      - `self` string, required
    - `relationships` object, required
      - `assignedAgents` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'agent', required
          - `id` integer, required
      - `crackerBinary` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'crackerBinary', required
          - `id` integer, required
      - `crackerBinaryType` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'crackerBinaryType', required
          - `id` integer, required
      - `files` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'file', required
          - `id` integer, required
      - `hashlist` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'hashlist', required
          - `id` integer, required
      - `speeds` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'speed', required
          - `id` integer, required
  - `included` union[]
    - union
      - object
        - `id` integer, required
        - `type` 'crackerBinary', required
        - `attributes` object, required
          - `crackerBinaryTypeId` integer, required
          - `version` string, required
          - `downloadUrl` string, nullable, required: External http/https url where the agent downloads the binary archive from. The server keeps a local copy of the archive for later analysis: on creation it is downloaded from this url, and changing the url re-downloads it from the new url. The creation or change is rejected if that download fails or the archive is not a valid 7z file. Mutually exclusive with sourceType: when the archive is uploaded with sourceType, this url is set automatically to the download endpoint of this server and cannot be changed afterwards.
          - `binaryName` string, required
          - `filename` string, nullable, required: Filename of the locally stored 7z archive, null when the binary is downloaded from the downloadUrl. Cannot be provided.
          - `accessGroupId` integer, required: Access group containing this cracker binary. Required on creation; the requesting user must belong to the group. It can be changed only when the user belongs to both the current and new groups.
      - object
        - `id` integer, required
        - `type` 'crackerBinaryType', required
        - `attributes` object, required
          - `typeName` string, required
          - `isChunkingAvailable` boolean, nullable, required
      - object
        - `id` integer, required
        - `type` 'hashlist', required
        - `attributes` object, required
          - `name` string, required
          - `format` union, required
            - 0
            - 1
            - 2
            - 3
          - `hashTypeId` integer, required
          - `hashCount` integer, required
          - `separator` string, nullable, required
          - `cracked` integer, required
          - `isSecret` boolean, required
          - `isHexSalt` boolean, required
          - `isSalted` boolean, required
          - `accessGroupId` integer, required
          - `notes` string, required
          - `useBrain` boolean, required
          - `brainFeatures` integer, required
          - `isArchived` boolean, required
      - object
        - `id` integer, required
        - `type` 'agent', required
        - `attributes` object, required
          - `agentName` string, required
          - `uid` string, required
          - `os` union, required
            - 0
            - 1
            - 2
          - `devices` string, required
          - `cmdPars` string, required
          - `ignoreErrors` union, required
            - 0
            - 1
            - 2
          - `isActive` boolean, required
          - `isTrusted` boolean, required
          - `token` string, required
          - `lastAct` string, required
          - `lastTime` integer, required
          - `lastIp` string, required
          - `userId` integer, nullable, required
          - `cpuOnly` boolean, required
          - `clientSignature` string, required
      - object
        - `id` integer, required
        - `type` 'file', required
        - `attributes` object, required
          - `filename` string, required
          - `size` integer, required
          - `isSecret` boolean, required
          - `fileType` union, required
            - 0
            - 1
            - 2
            - 100
          - `accessGroupId` integer, required
          - `lineCount` integer, required
      - object
        - `id` integer, required
        - `type` 'speed', required
        - `attributes` object, required
          - `agentId` integer, required
          - `taskId` integer, required
          - `speed` integer, required
          - `time` integer, required

## 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/chunks/:id/task/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)