---
title: "Get AgentAssignments"
method: GET
path: "/api/v2/ui/agentassignments/{id}/agent"
tags: ["AgentAssignments"]
---

# Get AgentAssignments

`GET /api/v2/ui/agentassignments/{id}/agent`

## Request

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

- AgentResponse
  - `jsonapi` object, required
    - `version` string, required
    - `ext` string[]
  - `links` object, required
    - `self` string, required
  - `data` object, required
    - `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
      - `crackingTime` integer
    - `links` object, required
      - `self` string, required
    - `relationships` object, required
      - `accessGroups` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'accessGroup', required
          - `id` integer, required
      - `agentErrors` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'agentError', required
          - `id` integer, required
      - `agentStats` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'agentStat', required
          - `id` integer, required
      - `assignments` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'agentAssignment', required
          - `id` integer, required
      - `chunks` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'chunk', required
          - `id` integer, required
      - `tasks` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object[]
          - `type` 'task', required
          - `id` integer, required
      - `user` object, required
        - `links` object, required
          - `self` string, required
          - `related` string, required
        - `data` object, nullable
          - `type` 'user', required
          - `id` integer, required
  - `included` union[]
    - union
      - 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
      - object
        - `id` integer, required
        - `type` 'accessGroup', required
        - `attributes` object, required
          - `groupName` string, required
      - object
        - `id` integer, required
        - `type` 'agentStat', required
        - `attributes` object, required
          - `agentId` integer, required
          - `statType` union, required
            - 1
            - 2
            - 3
          - `time` integer, required
          - `value` integer[], required
      - object
        - `id` integer, required
        - `type` 'agentError', required
        - `attributes` object, required
          - `agentId` integer, required
          - `taskId` integer, required
          - `chunkId` integer, nullable, required
          - `time` integer, required
          - `error` string, required
      - object
        - `id` integer, required
        - `type` 'chunk', required
        - `attributes` object, required
          - `taskId` integer, required
          - `skip` integer, required
          - `length` integer, required
          - `agentId` integer, nullable, required
          - `dispatchTime` integer, required
          - `solveTime` integer, required
          - `checkpoint` integer, required
          - `progress` integer, required
          - `state` union, required
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
          - `cracked` integer, required
          - `speed` integer, required
      - object
        - `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
      - object
        - `id` integer, required
        - `type` 'agentAssignment', required
        - `attributes` object, required
          - `taskId` integer, required
          - `agentId` integer, required
          - `benchmark` string, 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/agentassignments/:id/agent/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)