---
title: "List users"
method: GET
path: "/scim/v2/Users"
tags: ["SCIM"]
---

# List users

`GET /scim/v2/Users`

Returns a paginated list of users, 100 users per page by default.
When querying larger instances, reduce the count parameter to 1,000 or less, and use the startIndex parameter to paginate through users.
It's possible to return a list of specific types of users with the filter parameter.
Examples:
```
  /list?filter=userName eq "testuser"
  /list??filter=status eq "PENDING_ACTIVATION"
  /list??filter=id eq "91f659cd-6ded-4d92-aa5c-144c3b5455c3" and status eq "PENDING_ACTIVATION"
```

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string

## Response `200`

OK

- object
  - `schemas` string[] — A list of schema URNs that describe the structure of the response.
  - `totalResults` integer — The total number of results matching the query.
  - `resources` object[]
    - `schemas` string[] — A list of schema URNs that describe the structure of the user resource.
    - `id` string — The unique identifier for the user resource.
    - `meta` object
      - `created` string, date-time — The timestamp when the user resource was created.
      - `resourceType` string — The type of resource, in this case, 'User'.
      - `location` string — The URI of the user resource.
    - `userName` string — The username associated with the user account.
    - `name` object
      - `formatted` string — The full name of the user, formatted for display.
      - `familyName` string — The user's family (last) name.
      - `givenName` string — The user's given (first) name.
    - `displayName` string — The display name of the user.
    - `preferredLanguage` string — The preferred language of the user.
    - `locale` string — The locale of the user.
    - `active` boolean — Indicates whether the user account is active.
    - `emails` object[]
      - `value` string — The email address of the user.
      - `display` string — The display name associated with the email address.
      - `type` string — The type of email address (e.g., work, home).
      - `primary` boolean — Indicates whether this email address is the primary one for the user.
    - `roles` object[]
      - `value` string — The role identifier associated with the user.
      - `display` string — The display name of the role.
    - `groups` object[]
      - `value` string — The group identifier to which the user belongs.
      - `display` string — The display name of the group.
    - `urn:zuora:scim:schemas:1.0:UserExtension` object
      - `schemas` string[] — A list of schema URNs specific to the UserExtension.
      - `organizationId` string — The identifier of the organization to which the user belongs.
      - `status` string — The current status of the user account (e.g., ACTIVE, PENDING_ACTIVATION).
      - `ssoEnabled` boolean — Indicates whether Single Sign-On (SSO) is enabled for the user.
      - `region` string — The region where the user is located.
  - `startIndex` integer — The index of the first result in the current page.
  - `itemsPerPage` integer — The number of items per page in the response.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

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