---
title: "List end-users with balances"
method: GET
path: "/credits/end-users"
tags: ["End users"]
---

# List end-users with balances

`GET /credits/end-users`

## Request

- Base URL: `https://api.paywithlocus.com/api`
- URL: `https://api.paywithlocus.com/api/credits/end-users`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Lists the workspace's end-user accounts with their balances, with cursor pagination. q filters by a case-insensitive substring of externalUserId.

## Query parameters

- `q` string
- `cursor` string
- `limit` integer

## Response `200`

End-user accounts

- object
  - `success` unknown, required
  - `endUsers` EndUserAccount[], required
    - `externalUserId` string, required: Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.
    - `accountId` string, uuid, required
    - `balanceUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `balanceCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `status` 'active' | 'frozen', required
    - `createdAt` string, date-time, required
  - `nextCursor` string, nullable, required

---

[API](https://skmtc.dev/paywithlocus/apis/locus-pro-api.md) - [All operations](https://skmtc.dev/paywithlocus/apis/locus-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paywithlocus/apis/locus-pro-api/revisions/aab8fa5d6cef?raw)