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

# List users

`GET /v1/users`

## Request

- Base URL: `https://api.capacity.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.capacity.com/v1/users`
- Auth: one of:
  - API key in header `x-capacity-id`
  - HTTP bearer

List user records. Results are paginated.

## Query parameters

- `page` integer
- `limit` integer
- `email` string
- `include_deactivated_users` unknown

## Response `200`

An array of user objects

- object
  - `body` object: Json body data in the request
  - `limit` integer: Number of results returned
  - `page` integer: Page of results returned
  - `parameters` object: Query parameters in the request
  - `result` UserGetSchema[]
    - `id` string
    - `first_name` string
    - `last_name` string
    - `email` string
    - `is_deleted` unknown
    - `custom1` string, nullable
    - `custom2` string, nullable
    - `groups` GroupGetSchema[]
      - `id` string: ID of a group record
      - `name` string: The group's name
    - `attributes` UserAttributeGetSchema[]
      - `key` string: Attribute key
      - `value` string: Attribute value

---

[API](https://skmtc.dev/capacity/apis/capacity-api-docs.md) - [All operations](https://skmtc.dev/capacity/apis/capacity-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/capacity/apis/capacity-api-docs/revisions/74c85bb61004?raw)