---
title: "Admin List Clients"
method: GET
path: "/api/v1/admin/clients"
tags: ["admin"]
---

# Admin List Clients

`GET /api/v1/admin/clients`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/admin/clients`
- Auth: HTTP bearer

Paged client list with optional filters. Returns ``total`` so the UI
can render a proper paginator.

## Query parameters

- `limit` integer
- `offset` integer
- `plan` 'solo' | 'starter' | 'growth' | 'scale'
- `guarantee` 'pilot' | 'active' | 'inactive'
- `q` string, nullable: Substring search on email/company_name

## Response `200`

Successful Response

- AdminClientList
  - `items` AdminClientRow[], required
    - `id` string, uuid, required
    - `email` string, required
    - `company_name` string, required
    - `role` string, required
    - `subscription_plan` string, nullable, required
    - `plan_comped` boolean, required
    - `guarantee_status` string, required
    - `pilot_start_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `credits_balance` integer, required
    - `credits_included` integer, required
    - `lead_count` integer, required
    - `account_count` integer, required
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/nudgelink/apis/nudgelink-api.md) · [All operations](https://skmtc.dev/nudgelink/apis/nudgelink-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nudgelink/apis/nudgelink-api/revisions/baa46e6db986?raw)