---
title: "List the customer directory"
method: GET
path: "/credits/customers"
tags: ["Customers"]
---

# List the customer directory

`GET /credits/customers`

## Request

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

Display data a tenant registered for the customers it attributes charges to (X-Locus-Attribution source and customerId), in creation order. Enterprise workspaces only.

## Query parameters

- `source` string
- `cursor` string
- `limit` integer

## Response `200`

Directory entries

- object
  - `success` true, required
  - `customers` CustomerDirectoryEntry[], required
    - `source` string, required
    - `customerId` string, required
    - `name` string, required
    - `url` string, nullable, required
    - `adminUrl` string, nullable, required
    - `updatedAt` string, date-time, required
  - `nextCursor` string, nullable, required

## Other responses

- `400`: Invalid cursor, limit, or source
- `401`: Missing, invalid, expired, or revoked management credential
- `403`: The authenticated management credential lacks one or more required scopes

---

[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)
