---
title: "Get Agents"
method: GET
path: "/v1/agents"
tags: ["V1 - Agents (Co-workers)"]
---

# Get Agents

`GET /v1/agents`

## Request

- Base URL: `https://api.app.noxus.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.app.noxus.ai/v1/agents`
- Auth: API key in header `X-API-Key`

## Query parameters

- `query` string, nullable
- `status` string, nullable
- `order_by` string
- `sort` string
- `page` integer: Page number
- `size` integer: Page size

## Response `200`

Successful Response

- PageSdkAssistant
  - `items` SdkAssistant[], required
    - `id` string, uuid, required
    - `group_id` string, uuid, required
    - `name` string, required
    - `description` string, nullable
    - `definition` object, required
    - `visible` boolean
    - `image_url` string, nullable
    - `last_updated_at` string, date-time, nullable
    - `deleted_at` string, date-time, nullable
    - `app_settings_v2` AppSettingsV2
      - `is_active` boolean
      - `version_id` string, nullable
      - `interface_type` 'slack' | 'teams' | 'chat' | 'form' | 'whatsapp' | 'embed_widget' | 'telegram'
      - `extra_settings` object, nullable
      - `published_at` string, date-time, nullable
    - `is_app_published` boolean, nullable
    - `allow_public_access` boolean
    - `meta` AssistantMeta
      - `template_id` string, nullable
      - `is_genie` boolean, nullable
      - `source` 'genie' | 'user': Who authored an entity (or version). Absent/``user`` means a person made it; ``genie`` marks something the platform assistant created on their behalf, so the frontend can badge it.
    - `draft_definition` object, nullable
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required
  - `pages` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/noxus/apis/noxus-backend.md) - [All operations](https://skmtc.dev/noxus/apis/noxus-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/noxus/apis/noxus-backend/revisions/0e37810b7ad5?raw)