---
title: "List end users"
method: GET
path: "/beta/endusers"
tags: ["End Users"]
---

# List end users

`GET /beta/endusers`

Lists all end users 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.<br/> <b>Note:</b> Custom attributes are not part of the response at this point. If you need to get custom attributes for a user use the [GET /endusers/{userId}](../End-Users/#tag/End-Users/operation/getEndusersUserid) endpoint

## Query parameters

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

## Response `200`

The list of end users

- ListEndUsersOutput
  - `data` EndUser[]
    - `id` string, uuid, required — Unique identifier for the contact
    - `createdAt` string, date-time, required — Time when the contact was created
    - `displayName` string — The contact's display name
    - `email` string — The contact's primary email address
    - `phoneNumber` string — The contact's primary phone number
    - `additionalEmails` string[] — Additional email addresses for the contact
    - `additionalPhoneNumbers` string[] — Additional phone numbers for the contact
    - `firstName` string — The contact's first name
    - `lastName` string — The contact's last name
    - `middleNames` string[] — The contact's middle names
    - `avatarUrl` string — The url from which to load the contact's avatar
    - `externalId` string — Custom external identifier for the contact
    - `customAttributes` CustomAttribute[] — Custom attributes for the contact
      - `id` string, uuid, required
      - `name` string, required
      - `identifier` string, required
      - `value` union, required — AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text
        - string[]
        - string
  - `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, Invalid value for: query parameter externalId, Duplicate phone number, Duplicate email address, Invalid filters: Cannot provide more than one filter
- `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/versions/5eaff14a2c46/schema)