---
title: "List users"
method: POST
path: "/users/search"
tags: ["Account"]
---

# List users

`POST /users/search`

## Request

- Base URL: `https://api.copper.com/developer_api/v1`
- URL: `https://api.copper.com/developer_api/v1/users/search`
- Auth: HTTP bearer

Retrieve all users. Response returns a pagination envelope (`page_number`, `total`, `data`) so ChatGPT can read pagination info; the X-PW-TOTAL header remains available. Continue paging with page_number/page_size until the received records match the total value.

## Request body

- object
  - `page_number` integer: The page number (starting with 1) that you would like to view
  - `page_size` integer: The number of entries included in a page of results

## Response `200`

Users retrieved successfully

- object: Standard paginated response envelope returned for ChatGPT-only requests. Mirrors the previous pagination headers by surfacing totals inside the response body while keeping the original headers available.
  - `page_number` integer, required: Current page number (defaults to 1 when not provided in the request).
  - `total` integer, required: Total number of records that match the request filters (equivalent to the X-PW-TOTAL header).
  - `data` User[], required: Records returned for the requested page. The item schema depends on the endpoint using this envelope.
    - `id` integer, required: Unique identifier for the user
    - `name` string, required: Full name of the user
    - `email` string, email, required: Email address of the user
    - `groups` object[]: A list of teams (previously known as 'Groups') that the user belongs to
      - `id` integer, required: Unique identifier for the team
      - `name` string, required: Name of the team

## Other responses

- `400`: Bad Request - The request was invalid or cannot be served
- `401`: Unauthorized - Authentication credentials were missing or incorrect
- `429`: Too Many Requests - Rate limit exceeded
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/copper/apis/copper-crm-read-only-api.md) - [All operations](https://skmtc.dev/copper/apis/copper-crm-read-only-api/llms.txt) - [OpenAPI document](https://skmtc.dev/copper/apis/copper-crm-read-only-api/revisions/96adc8557a40?raw)