---
title: "GET /customers"
method: GET
path: "/customers"
tags: ["Customers"]
---

# GET /customers

`GET /customers`

Gets the latest customers for a business.

## Query parameters

- `businessName` string, required
- `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks', required
- `offset` number
- `limit` number
- `orderBy` string

## Response `200`

- GetCustomerResponseDto
  - `pagination` PaginationMetaData, required
    - `offset` number, required
    - `limit` number, required
    - `count` number, required
  - `count` number, required
  - `meta` ListReportMetaData, required
    - `reportId` string[], required
    - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
    - `businessName` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `data` GetCustomerData[], required
    - `id` string, required
    - `customerName` string, required
    - `contactName` string
    - `emailAddress` string
    - `website` string
    - `phone` string
    - `taxNumber` string
    - `balance` number, float
    - `status` 'unknown' | 'active' | 'archived', required
    - `subsidiaryRefs` SubsidiaryRef[]
      - `id` string
      - `name` string
    - `sourceModifiedDate` string
    - `parentRef` ParentRef
      - `id` string, required
      - `name` string
    - `contacts` Contact[]
      - `name` string
      - `email` string
      - `phone` string
      - `address` Address
        - `line1` string
        - `line2` string
        - `city` string
        - `region` string
        - `country` string
        - `postalCode` string
        - `type` 'billing' | 'shipping' | 'other', required
      - `status` 'unknown' | 'active' | 'archived', required
      - `modifiedDate` string
    - `defaultCurrency` CurrencyRef
      - `id` string, required
      - `name` string
      - `symbol` string
    - `addresses` Address[]
      - `line1` string
      - `line2` string
      - `city` string
      - `region` string
      - `country` string
      - `postalCode` string
      - `type` 'billing' | 'shipping' | 'other', required

## Other responses

- `202` — Data in pending state
- `204` — No data available
- `400` — Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401` — Unauthorized - Not logged in or log in expired
- `403` — Forbidden - Not enough permission
- `500` — Server Error

---

[API](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api.md) · [All operations](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/railz/fis-accounting-data-as-a-service-api/revisions/5cdfae3fa1fa/schema)