---
title: "List clients"
method: GET
path: "/clients"
---

# List clients

`GET /clients`

Returns clients for the requesting firm. Supports optional exact-match filters.

Notes:
- By default (`show_inactive=false`), only paying clients are returned.
- `email`, `fname`, `lname`, and `external_user_id` are exact matches.

## Query parameters

- `show_inactive` boolean
- `email` string, email
- `fname` string
- `lname` string
- `external_user_id` string
- `page` integer
- `per_page` integer

## Headers

- `ngrok-skip-browser-warning` string, required

## Response `200`

Array of clients

- Client[]
  - `id` integer, required
  - `email` string, email, required
  - `fname` string, required
  - `lname` string, required
  - `full_name` string, nullable
  - `time_zone` string, nullable
  - `phone_number` string, nullable
  - `preferred_name` string, nullable
  - `created_at` string, date-time, required
  - `active` boolean, required — Derived from User#paying
  - `assigned_advisor_id` integer, required
  - `work_phone_number` string, nullable
  - `work_phone_extension` string, nullable
  - `work_email` string, email, nullable
  - `external_user_id` string, nullable
  - `assigned_advisor` string, nullable — Assigned advisor full name (string), not an object

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/soraban/apis/soraban-private-api.md) · [All operations](https://skmtc.net/soraban/apis/soraban-private-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/soraban/soraban-private-api/versions/0dfdfa10c993/schema)