---
title: "List agents"
method: GET
path: "/beta/agents"
tags: ["Agents"]
---

# List agents

`GET /beta/agents`

Lists all agents/admins in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.

## Query parameters

- `pageLimit` integer
- `pageKey` string
- `email` string
- `phone` string

## Response `200`

The list of agents/admins

- ListAgentsOutput
  - `data` Agent[]
    - `id` string, uuid, required — Unique identifier for the agent
    - `createdAt` string, date-time, required — Time when the agent was created
    - `displayName` string, required — The agent's display name
    - `email` string, required — The agent's primary email address
    - `avatarUrl` string — The url from which to load the agent's avatar
    - `phoneNumber` string — The agent's primary phone number
    - `additionalEmails` string[] — Additional email addresses for the agent
    - `additionalPhoneNumbers` string[] — Additional phone numbers for the agent
    - `firstName` string — The agent's first name
    - `lastName` string — The agent's last name
    - `middleNames` string[] — The agent's middle names
    - `roles` string[] — The agent's roles
  - `meta` PaginationLinks
    - `previous` string — url
    - `next` string — url

## Other responses

- `400` — Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter email, Invalid value for: query parameter phone, Duplicate phone number, Duplicate email address, Invalid filters: Cannot provide both phone number and email address
- `404` — An entity in this request could not be found
- `500` — Internal failure during request processing

---

[API](https://skmtc.net/dixa/apis/dixa-api.md) · [All operations](https://skmtc.net/dixa/apis/dixa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dixa/dixa-api/revisions/5eaff14a2c46/schema)