---
title: "Get Agents Admin Paginated"
method: GET
path: "/admin/agents"
tags: ["public"]
---

# Get Agents Admin Paginated

`GET /admin/agents`

Paginated endpoint for listing agents (formerly personas) (admin view).

Returns items for the requested page plus total count.
Agents are ordered by display_priority (ASC, nulls last) then by ID (ASC).

## Query parameters

- `page_num` integer — Page number (0-indexed).
- `page_size` integer — Items per page.
- `include_deleted` boolean — If true, includes deleted personas.
- `get_editable` boolean — If true, only returns editable personas.
- `include_default` boolean — If true, includes builtin/default personas.

## Response `200`

Successful Response

- PaginatedReturnPersonaSnapshot
  - `items` PersonaSnapshot[], required
    - `id` integer, required
    - `name` string, required
    - `description` string, required
    - `is_public` boolean, required
    - `is_visible` boolean, required
    - `uploaded_image_id` string, nullable, required
    - `icon_name` string, nullable, required
    - `user_file_ids` string[], required
    - `display_priority` integer, nullable, required
    - `is_default_persona` boolean, required
    - `builtin_persona` boolean, required
    - `starter_messages` StarterMessage[], nullable, required
      - `name` string, required
      - `message` string, required
    - `llm_relevance_filter` boolean, required
    - `llm_filter_extraction` boolean, required
    - `tools` ToolSnapshot[], required
      - `id` integer, required
      - `name` string, required
      - `description` string, required
      - `definition` object, nullable, required
      - `display_name` string, required
      - `in_code_tool_id` string, nullable, required
      - `custom_headers` unknown[], nullable, required
        - unknown
      - `passthrough_auth` boolean, required
      - `mcp_server_id` integer, nullable
      - `user_id` string, nullable
      - `oauth_config_id` integer, nullable
      - `oauth_config_name` string, nullable
      - `enabled` boolean
      - `chat_selectable` boolean
      - `agent_creation_selectable` boolean
      - `default_enabled` boolean
    - `labels` PersonaLabelSnapshot[], required
      - `id` integer, required
      - `name` string, required
    - `owner` MinimalUserSnapshot, required
      - `id` string, uuid, required
      - `email` string, required
    - `users` MinimalUserSnapshot[], required
      - `id` string, uuid, required
      - `email` string, required
    - `groups` integer[], required
    - `document_sets` DocumentSetSummary[], required
      - `id` integer, required
      - `name` string, required
      - `description` string, nullable, required
      - `cc_pair_summaries` CCPairSummary[], required
        - `id` integer, required
        - `name` string, nullable, required
        - `source` 'ingestion_api' | 'slack' | 'web' | 'google_drive' | 'gmail' | 'requesttracker' | 'github' | 'gitbook' | 'gitlab' | 'guru' | 'bookstack' | 'outline' | 'confluence' | 'jira' | 'slab' | 'productboard' | 'file' | 'coda' | 'notion' | 'zulip' | 'linear' | 'hubspot' | 'document360' | 'gong' | 'google_sites' | 'zendesk' | 'loopio' | 'dropbox' | 'sharepoint' | 'teams' | 'salesforce' | 'discourse' | 'axero' | 'clickup' | 'mediawiki' | 'wikipedia' | 'asana' | 's3' | 'r2' | 'google_cloud_storage' | 'oci_storage' | 'xenforo' | 'not_applicable' | 'discord' | 'freshdesk' | 'fireflies' | 'egnyte' | 'airtable' | 'highspot' | 'drupal_wiki' | 'imap' | 'bitbucket' | 'testrail' | 'mock_connector' | 'user_file', required
        - `access_type` 'public' | 'private' | 'sync', required
      - `is_up_to_date` boolean, required
      - `is_public` boolean, required
      - `users` string[], required
      - `groups` integer[], required
      - `federated_connector_summaries` FederatedConnectorSummary[]
        - `id` integer, required
        - `name` string, required
        - `source` 'federated_slack', required
        - `entities` object, required
    - `llm_model_provider_override` string, nullable, required
    - `llm_model_version_override` string, nullable, required
    - `num_chunks` number, nullable, required
    - `system_prompt` string, nullable
    - `replace_base_system_prompt` boolean
    - `task_prompt` string, nullable
    - `datetime_aware` boolean
  - `total_items` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/onyx-dot-app/apis/agents-api.md) · [All operations](https://skmtc.net/onyx-dot-app/apis/agents-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onyx-dot-app/agents-api/versions/ea131344b29e/schema)