> ## Documentation Index
> Fetch the complete documentation index at: https://docs.support.onclarity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List agents



## OpenAPI

````yaml /api-reference/support-openapi.json get /api/agent/list
openapi: 3.1.0
info:
  title: Clarity Support API
  version: '1.0'
  description: Tickets, customers, messages, the knowledge base, and webhooks.
servers:
  - url: https://back.leap.onclarity.com
security:
  - organizationApiKey: []
tags:
  - name: AI service
    description: >-
      Hand a customer conversation to your Clarity AI agent from your own app or
      backend.
  - name: Messages
    description: Reply to customers on their ticket's channel and add private notes.
  - name: Customers
    description: Create, update, and look up customers and their custom attributes.
  - name: Tickets
    description: >-
      Change a ticket's status, assignee, category, and tags, and list the
      values they take.
  - name: Knowledge base
    description: Manage the articles your AI agents answer from.
  - name: Webhooks
    description: Subscribe your endpoints to events in your organization.
paths:
  /api/agent/list:
    get:
      tags:
        - Tickets
      summary: List agents
      operationId: ApiAgentListListAgents
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
          required: true
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: offset
          in: query
          schema:
            type: integer
          required: true
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: q
          in: query
          schema:
            oneOf:
              - type: string
                default: ''
              - type: 'null'
            default: ''
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: team_id
          in: query
          schema:
            oneOf:
              - items:
                  type: string
                type: array
              - type: 'null'
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: account_status
          in: query
          schema:
            oneOf:
              - $ref: '#/components/schemas/AgentAccountStatus'
              - type: 'null'
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: status
          in: query
          schema:
            oneOf:
              - items:
                  $ref: '#/components/schemas/AgentStatus'
                type: array
              - type: 'null'
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: used
          in: query
          schema:
            type: boolean
            default: false
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
        - name: at_capacity
          in: query
          schema:
            type: boolean
            default: false
          required: false
          deprecated: false
          allowEmptyValue: false
          allowReserved: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentListPayload'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KTSErrorResponse'
        '500':
          description: Server got itself in trouble
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KTSErrorResponse'
      deprecated: false
components:
  schemas:
    AgentAccountStatus:
      type: string
      enum:
        - active
        - blocked
        - not_active
      title: AgentAccountStatus
      description: Account status (active, disabled)
    AgentStatus:
      type: string
      enum:
        - online
        - offline
        - away
      title: AgentStatus
      default: offline
    AgentListPayload:
      properties:
        list:
          items:
            $ref: '#/components/schemas/AgentForListSchema'
          type: array
        total:
          type: integer
      type: object
      required:
        - list
        - total
      title: AgentListPayload
    KTSErrorResponse:
      properties:
        status:
          type: string
          default: error
        code:
          type: string
        message:
          oneOf:
            - type: string
            - type: 'null'
        extra:
          oneOf:
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
            - type: 'null'
      type: object
      required:
        - code
      title: KTSErrorResponse
    AgentForListSchema:
      properties:
        id:
          type: integer
        first_name:
          type: string
        last_name:
          oneOf:
            - type: string
            - type: 'null'
        email:
          type: string
        phone:
          oneOf:
            - type: string
            - type: 'null'
        role:
          $ref: '#/components/schemas/AgentRole'
        kind:
          $ref: '#/components/schemas/AgentKind'
        avatar_url:
          oneOf:
            - type: string
            - type: 'null'
        status:
          $ref: '#/components/schemas/AgentStatus'
        account_status:
          $ref: '#/components/schemas/AgentAccountStatus'
        capacity_profile_id:
          oneOf:
            - type: integer
            - type: 'null'
        teams:
          items:
            $ref: '#/components/schemas/TeamInfo'
          type: array
        effective_limits:
          additionalProperties:
            oneOf:
              - type: integer
              - type: 'null'
          type: object
        open_counts:
          additionalProperties:
            type: integer
          type: object
        capacity_overrides:
          additionalProperties:
            oneOf:
              - type: integer
              - type: 'null'
          type: object
      type: object
      required:
        - account_status
        - email
        - first_name
        - id
        - kind
        - role
        - status
      title: AgentForListSchema
    AgentRole:
      type: string
      enum:
        - agent
        - business_user
        - super_admin
        - viewer
        - engineering
      title: AgentRole
      description: Agent role (agent, business_user)
    AgentKind:
      type: string
      enum:
        - human
        - ai
      title: AgentKind
    TeamInfo:
      properties:
        id:
          type: integer
        name:
          type: string
      type: object
      required:
        - id
        - name
      title: TeamInfo
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: >-
        Your organization API key (it starts with `anek_org_`). The same key
        works on the Voice API and the Support API. See
        [Authentication](/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.