---
title: "List users"
method: GET
path: "/v3/users"
tags: ["Users"]
---

# List users

`GET /v3/users`

Retrieves a list of users wrapped in the element "results".

## Query parameters

- `identifiers.email_address` string, required
- `identifiers.username` string, required
- `foreign_key.xxx` string, required
- `search` string, required
- `search_by_attributes` AttributeSearchFilter[]
  - `slug` string — The user attribute slug
  - `operator` 'is' | 'is_not' | 'contains' | 'does_not_contain' | 'starts_with' | 'ends_with' | 'has_any_value' | 'is_unknown' | 'checked' | 'unchecked' — The operation to apply to search filters for fields that are not of type Number, Range, or Date.
  - `value` object — The value assigned to the user attribute. Supported types include string, boolean, integer, and double.
  - `from` object — Used with Number, Range, or Date fields to specify the starting value of the search range.
  - `to` object — Used with Number, Range, or Date fields to specify the ending value of the search range.

## Response `200`

OK

- UsersResponse
  - `results` UserResponse[]
    - `user_id` string
    - `identifiers` Identifiers
      - `email_address` string
    - `attributes` Attributes
      - `first_name` string
      - `surname` string
    - `email_verified` boolean

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/zuora/apis/admin-api-reference.md) · [All operations](https://skmtc.net/zuora/apis/admin-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zuora/admin-api-reference/revisions/789812d35ac8/schema)