---
title: "Retrieves the collection of Customer resources."
method: GET
path: "/customers"
tags: ["Customer"]
---

# Retrieves the collection of Customer resources.

`GET /customers`

Retrieves the collection of Customer resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Customer collection

- Customer[]
  - `id` string — Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050"
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — The unique identifier of the source 3rd party integration e.g. "50"
  - `email` string, nullable — Email address for the customer e.g. "janedoe@email.com"
  - `name` string, nullable — Full name of the customer e.g. "Jane Doe"
  - `givenName` string, nullable — First name of the customer e.g. "Jane"
  - `familyName` string, nullable — Last name of the customer e.g. "Doe"
  - `companyName` string, nullable — Name of the company the customer is working on e.g. "Acme Corp."
  - `fullyQualifiedName` string, nullable — Fully qualified name of the company the customer is working on e.g. "Acme Corporation"
  - `address` string, nullable — First line of customer address e.g. "708 Woodland Avenue"
  - `addressLine2` string, nullable — Second line of customer address e.g. "Unit 105"
  - `city` string, nullable — City of the address e.g. "St Paul"
  - `postalCode` string, nullable — Postal code of the address * e.g. "99660"
  - `country` string, nullable — Country of the address * e.g. "United States"
  - `billingAddress` string, nullable — Billing address line 1 e.g. "4348 Candlelight Drive"
  - `billingAddressLine2` string, nullable — Billing address line 2 e.g. "Apartment 78"
  - `billingCity` string, nullable — Billing address city e.g. "Panama City"
  - `billingState` string, nullable — Billing address state or province e.g. "Florida"
  - `billingPostalCode` string, nullable — Billing address postal code e.g. "32417"
  - `billingCountry` string, nullable — Billing address country e.g. "United States"
  - `phone` string, nullable — Phone number e.g. "281-381-4241"
  - `mobile` string, nullable — Mobile number e.g. "786-258-0182"
  - `fax` string, nullable — Fax number e.g. "281-381-4255"
  - `ddi` string, nullable — Direct dial number e.g. "5050"
  - `balance` integer, nullable — Balance owed by customer in cents e.g. 19999
  - `currency` string, nullable — Currency used by customer e.g. "USD"
  - `taxable` boolean, nullable — Taxable status
  - `customerAccountStatus` string, nullable — Accounting status of the customer e.g. "Enabled"
  - `monthlyRecurringRevenue` integer, nullable — Monthly recurring revenue in cents e.g. 4500000
  - `netMonthlyRecurringRevenue` integer, nullable — Net monthly recurring revenue e.g. 2500000
  - `created` string, date-time, nullable — Date of customer account creation e.g. "2013-11-18T02:17:40.080Z"
  - `modified` string, date-time, nullable — Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"
  - `title` string, nullable — Job title of the customer e.g. "Manager"
  - `department` string, nullable — Department where customer works in e.g. "Administrative office"
  - `customerOwner` string, nullable — User in touch with the customer e.g. "josh_jameson"
  - `description` string, nullable — A note about the customer e.g. "Great customer"
  - `totalSpent` integer, nullable — Total spent by customer in cents e.g. 76000
  - `acceptsMarketing` boolean, nullable — Whether the customer has consented to receiving promotional emails
  - `username` string, nullable — Username of the customer e.g. "jane_doe123"
  - `taxType` string, nullable — Tax type applied for the customer e.g. "Global"
  - `bankAccountName` string, nullable — Bank account name for the customer e.g. "Business Bank Account"
  - `bankAccountNumber` string, nullable — Bank account number for the customer e.g. "123654"
  - `termId` string, nullable — Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"
  - `termDays` integer, nullable — The days value of the payment terms for this Customer e.g. "15"
  - `termType` string, nullable — The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE"

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/revisions/d08a107895ad/schema)