---
title: "List customers · Customers · Practice Manager API · COUNT Partner API"
description: "Returns a paginated list of customers in the workspace. GET /firm-partners/workspace/customers"
canonical: "https://developers.getcount.com/practice-manager/reference/customers/list-customers"
source: "https://developers.getcount.com/practice-manager/reference/customers/list-customers"
---
[Customers](https://developers.getcount.com/practice-manager/reference/customers) / List customers

# List customers

GET `/firm-partners/workspace/customers`

Returns a paginated list of customers in the workspace.

Customers are returned with their billing/shipping addresses, contacts, taxes, and sales rep embedded. Use search, status, and ordering to narrow the results. The response includes a `filters` object echoing applied query parameters.

HMAC signature only

[Invoices API](https://developers.getcount.com/practice-manager/reference/invoices) [Projects API](https://developers.getcount.com/practice-manager/reference/projects) [Recurring Invoice Templates API](https://developers.getcount.com/practice-manager/reference/recurring-invoice-templates)

#### Headers

`count-workspace-id` uuid required

UUID of the client workspace to act on. It must be one of your firm's client workspaces (or the firm's own workspace) and within the API key's client workspaces.

#### Query parameters

`search` string optional

Partial, case-insensitive match across the customer name, contact name, and contact phone numbers.

`status` enum optional

Filters by customer status.

One of: `active`, `inactive`

`orderBy` enum optional

Field to sort results by. Defaults to customer.

One of: `customer`, `email`, `createdAt`, `updatedAt`

`orderDirection` enum optional

Sort direction. Defaults to ASC.

One of: `ASC`, `DESC`

`page` integer optional

Page number for pagination. The first page is 1.

`limit` integer optional

Records to return per page.

`updatedSince` string optional

Incremental sync. Returns only records created or changed at or after this ISO 8601 date-time (read as UTC when it has no offset), oldest change first, with `nextUpdatedSince` and `hasMore` beside the rows. Pass `nextUpdatedSince` back as `updatedSince` to read the next page; once `hasMore` is false, keep it for the next poll. Cannot be combined with `page` above 1 or a sort parameter (400).

`includeDeleted` boolean optional

Also return deleted records, each with `isDeleted: true`, so a sync can remove them. Records removed outright are listed by GET /firm-partners/workspace/deleted-records instead.

#### Responses

`200` Paginated list of customers. `results` is the number of rows on this page; `totalRecords` counts every match.

`400` The `count-workspace-id` header is missing.

`401` Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

`403` The key is inactive or its scope does not allow this request, the workspace is not managed by your firm or is outside the key's client workspaces, the workspace has no active subscription, or it is portal-only and the route needs bookkeeping. [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

`404` No workspace exists with the `count-workspace-id` UUID.

`429` Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

[Next GET Get a customer](https://developers.getcount.com/practice-manager/reference/customers/get-customer)

GET `https://api.getcount.com/firm-partners/workspace/customers`

Request

```javascript
import crypto from 'node:crypto';

const BASE_URL = 'https://api.getcount.com';
const CLIENT_ID = process.env.COUNT_CLIENT_ID;
const CLIENT_SECRET = process.env.COUNT_CLIENT_SECRET;

const method = 'GET';
const signingPath = '/workspace/customers';
const timestamp = Math.floor(Date.now() / 1000).toString();
const bodyString = '';

const bodyHash = '';
const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;
const signature = crypto.createHmac('sha256', CLIENT_SECRET).update(baseString).digest('hex');

const response = await fetch(`${BASE_URL}/firm-partners/workspace/customers`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
  },
});

console.log(await response.json());
```

Response · 200

```json
{
  "status": "success",
  "message": "Success on fetching customers.",
  "data": {
    "page": 1,
    "limit": 20,
    "results": 1,
    "totalRecords": 1,
    "records": [
      {
        "id": "dfa3219e-6af8-4c53-997a-037534f63a35",
        "customer": "Acme Corporation",
        "email": "contact@acme.com",
        "mainPhone": "+1234567890",
        "website": "https://acme.com",
        "status": "active",
        "notes": "Preferred customer. Net-30 terms.",
        "paymentTerm": "net30",
        "taxNumber": null,
        "taxAutoCalculate": false,
        "taxExcluded": false,
        "contactName": "John Doe",
        "billingAddress": {
          "id": "0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12",
          "street": "123 Main St",
          "city": "San Francisco",
          "state": "CA",
          "zipCode": "94102",
          "country": "USA"
        },
        "shippingAddress": null,
        "contacts": [
          {
            "id": "a5da3577-bf85-4e3a-aa73-df85ca69bc67",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john@acme.com",
            "phone": "+1234567890",
            "isPrimary": true
          }
        ],
        "taxes": [],
        "salesRep": null,
        "createdAt": "2026-01-15T10:30:00.000Z",
        "updatedAt": "2026-01-28T14:22:30.000Z"
      }
    ],
    "filters": {
      "search": null,
      "status": null,
      "orderBy": "customer",
      "orderDirection": "ASC"
    }
  }
}
```
