Get Customers | Papertracc Docs

{
  "data": [
    {
      "id": "7d2c9c72-392c-4f8d-b3f1-c1fef2c2d501",
      "type": "INDIVIDUAL",
      "email": "john@example.com",
      "phone": "+2348012345678",
      "accounts": [
        {
          "bank": "Spruce Bank",
          "code": "044",
          "vat_id": "78c68f6d-d734-4822-9a6c-73f517a0e5c1",
          "is_default": true,
          "account_name": "John Doe",
          "currency_code": "NGN",
          "account_number": "1234567890"
        }
      ],
      "last_name": "Doe",
      "contact_id": "64595845-34ec-482c-b0fe-ae617a0f8335",
      "created_at": "2026-06-18T10:00:00Z",
      "first_name": "John",
      "project_id": "spruce-demo",
      "company_name": "Acme Corp",
      "display_name": "John Doe",
      "billing_address": {
        "city": "Lagos",
        "name": "Office",
        "phone": "+2348012345678",
        "state": "Lagos",
        "country": "Nigeria",
        "post_code": "100001",
        "address_one": "12 Marina Road",
        "country_code": "NG"
      },
      "shipping_address": {
        "city": "Lagos",
        "name": "Office",
        "phone": "+2348012345678",
        "state": "Lagos",
        "country": "Nigeria",
        "post_code": "100001",
        "address_one": "12 Marina Road",
        "country_code": "NG"
      },
      "payment_term_id": null
    }
  ],
  "page": 0,
  "count": 1,
  "pages": 1,
  "status": true,
  "message": "Successfully fetched customers"
}

Lists customers for the active workspace.

Requires the can_view_customer_profile permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring

The identity for the active workspace.

Query parameters

limitintegerOptional

Optional. Number of records to return.

Response

datalist of objects

pageinteger

countinteger

pagesinteger

statusboolean

messagestring

keysetanyOptional

last_idanyOptional

Errors

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error