> ## Documentation Index
> Fetch the complete documentation index at: https://developer.zeeg.me/llms.txt
> Use this file to discover all available pages before exploring further.

# List AI Agents

> List the AI voice agents in your workspace, newest first, with their phone line, language and call totals.



## OpenAPI

````yaml GET /agents
openapi: 3.0.0
info:
  title: Zeeg Public API
  description: >-
    Zeeg public API documentation.


    ## Authentication

    All endpoints require a Bearer token. You can generate an API token from
    [your Zeeg dashboard](https://app.zeeg.me/account/settings/api-access).


    Each token is scoped to specific permissions (e.g. `events:read`,
    `webhooks:write`). Make sure your token has the required scopes for the
    endpoints you want to use.


    ## Recommended Headers

    We recommend including the `Accept: application/json` header in all API
    requests to ensure you receive JSON responses.
  version: 2.0.0
  x-logo:
    url: https://app.zeeg.me/img/logo-dark.2ca83593.svg
    backgroundColor: '#f7f7f9'
    altText: zeeg
  contact:
    name: Zeeg Support
    email: support@zeeg.me
    url: https://zeeg.me/en/contact
  license:
    name: Proprietary
    url: https://zeeg.me/en/legal/terms
  termsOfService: https://zeeg.me/en/legal/terms
servers:
  - url: https://api.zeeg.me/v2
    description: Production
security:
  - bearer: []
tags:
  - name: Scheduled Events
    description: Management of events scheduled via Zeeg
  - name: Scheduling Pages
    description: Scheduling pages information and management
  - name: Availability Schedule
    description: Read and change availability for users
  - name: Webhooks
    description: Webhooks management
  - name: Notes
    description: Notes for scheduled events
  - name: Workspaces & Teams
    description: Workspace users and team member management
  - name: AI Agent
    description: AI Agent integration endpoints
  - name: Payloads
    description: Webhook payload schemas
  - name: CRM - Objects
    description: >-
      Discover the schema of CRM objects (standard and custom) including all
      attribute definitions
  - name: CRM - Companies
    description: Create, read, update, and delete CRM company records
  - name: CRM - People
    description: Create, read, update, and delete CRM person records
  - name: Routing Forms - Forms
    description: Read routing forms with their questions and their routes
  - name: Routing Forms - Submissions
    description: Read and delete the submissions that invitees send through a routing form
paths:
  /agents:
    get:
      tags:
        - AI Agent
      summary: List AI agents
      description: >-
        Returns the voice agents of your workspace, newest first.


        Only workspace owners, admins and partners can read agents, and only on
        a plan that includes AI agents. Anyone else receives 403.


        **Required scope:** `agents:read`
      operationId: get-agents
      parameters:
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          description: Page number.
        - name: perPage
          in: query
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
          description: Number of agents per page.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  status:
                    type: integer
                    example: 200
                  data:
                    type: object
                    properties:
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                      agents:
                        type: array
                        items:
                          $ref: '#/components/schemas/AiAgent'
              examples:
                Success:
                  value:
                    success: true
                    status: 200
                    data:
                      pagination:
                        totalItems: 1
                        perPage: 20
                        currentPage: 1
                        lastPage: 1
                        hasPreviousPage: false
                        hasNextPage: false
                      agents:
                        - id: 9a39bf60-a6c3-45e7-80cd-2cd36e520861
                          title: Front Desk
                          language: de
                          additionalLanguages:
                            - en
                          active: true
                          phoneNumber: '+4989123456789'
                          totalCalls: 128
                          lastCallAt: '2026-06-01T10:00:05+00:00'
                          createdAt: '2026-03-02T09:15:00+00:00'
                          updatedAt: '2026-05-28T16:40:12+00:00'
        '401':
          $ref: '#/components/responses/401'
        '403':
          description: >-
            Forbidden — the token misses the scope, or the user may not read
            agents
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                          message:
                            type: string
                          error_id:
                            type: string
                          required_scopes:
                            type: array
                            items:
                              type: string
                  - type: object
                    properties:
                      success:
                        type: boolean
                      message:
                        type: string
                      data:
                        nullable: true
                      status:
                        type: integer
              examples:
                Missing scope:
                  value:
                    error:
                      type: insufficient_scope
                      message: >-
                        Your token is missing the required scope(s). Include at
                        least one of: agents:read.
                      error_id: 0b8f7c2e-3d41-4a6b-9f10-5e2c8d7a1b44
                      required_scopes:
                        - agents:read
                Not a member of the workspace:
                  value:
                    success: false
                    message: You are not a user of this organization.
                    data: null
                    status: 403
        '422':
          $ref: '#/components/responses/422'
      security:
        - bearer: []
components:
  schemas:
    Pagination:
      type: object
      description: The page counters that a paginated list response carries.
      properties:
        totalItems:
          type: integer
          description: Number of items that match the request across every page.
          example: 42
        perPage:
          type: integer
          description: Number of items on one page.
          example: 20
        currentPage:
          type: integer
          description: Number of the page in this response.
          example: 1
        lastPage:
          type: integer
          description: Number of the last page.
          example: 3
        hasPreviousPage:
          type: boolean
          description: True when a page comes before this one.
          example: false
        hasNextPage:
          type: boolean
          description: True when a page comes after this one.
          example: true
    AiAgent:
      type: object
      description: A voice agent in your workspace.
      properties:
        id:
          type: string
          format: uuid
          example: 9a39bf60-a6c3-45e7-80cd-2cd36e520861
        title:
          type: string
          example: Front Desk
        language:
          type: string
          description: The agent's primary language code.
          example: de
        additionalLanguages:
          type: array
          description: Further language codes the agent speaks.
          items:
            type: string
          example:
            - en
        active:
          type: boolean
          description: True when the agent takes and makes calls.
          example: true
        phoneNumber:
          type: string
          nullable: true
          description: >-
            The agent's phone line in E.164 format. `null` when no number is
            connected.
          example: '+4989123456789'
        totalCalls:
          type: integer
          description: Number of phone calls the agent has handled.
          example: 128
        lastCallAt:
          type: string
          format: date-time
          nullable: true
          description: When the agent's most recent phone call was recorded.
          example: '2026-06-01T10:00:05+00:00'
        createdAt:
          type: string
          format: date-time
          example: '2026-03-02T09:15:00+00:00'
        updatedAt:
          type: string
          format: date-time
          example: '2026-05-28T16:40:12+00:00'
  responses:
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthenticated.
          examples:
            Unauthenticated:
              value:
                message: Unauthenticated.
    '422':
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: The given data was invalid.
              errors:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                example:
                  field_name:
                    - The field_name field is required.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: ''

````