---
title: "Return a list of users either including copilots or excluding them."
method: GET
path: "/v1/users/copilots"
tags: ["Users"]
---

# Return a list of users either including copilots or excluding them.

`GET /v1/users/copilots`

## 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/copilots`
- Auth: one of:
  - API key in header `x-capacity-id`
  - HTTP bearer

Returns a list of users depending on if they are a copilot.

## Query parameters

- `include_copilots` boolean, required

## Response `200`

The requested list of users.

- object
  - `body` object: Json body data in the request
  - `parameters` object: Query parameters in the request
  - `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)