---
title: "Query customers"
method: POST
path: "/v6/customers/query"
tags: ["Customers"]
---

# Query customers

`POST /v6/customers/query`

Query customers for the authenticated user

## Request body

- CustomersGetParam
  - `cursor` string, nullable — Cursor from the previous paginated response
  - `limit` integer — Page size, i.e. number of items to return per page
  - `sort` CustomersSort — Sort order for the items in the response.
    - `orderBy` 'NAME' | 'EMAIL' — Sort column
    - `direction` 'ASC' | 'DESC' — Sort direction. Defaults to DESC
  - `filter` CustomersFilterParam — Filter for items in the response.
    - `search` string — Search filter
    - `name` StringFilter — Name filter
      - `equal` string — Value - returns all records with specified field equal to this value.
      - `notEqual` string — Value - returns all records with specified field not equal to this value.
      - `greaterThan` string — Value - returns all records with specified field greater than to this value.
      - `greaterThanEqual` string — Value - returns all records with specified field greater than or equal to this value.
      - `lessThan` string — Value - returns all records with specified field less than to this value.
      - `lessThanEqual` string — Value - returns all records with specified field less than or equal to this value.
      - `contain` string — Value - returns all records with specified field containing this value.
    - `status` EnumStatusListFilter — Status filter
      - `in` string[]
      - `notIn` string[]
      - `equal` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `notEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `greaterThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `greaterThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `lessThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `lessThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
    - `email` StringFilter — Name filter
      - `equal` string — Value - returns all records with specified field equal to this value.
      - `notEqual` string — Value - returns all records with specified field not equal to this value.
      - `greaterThan` string — Value - returns all records with specified field greater than to this value.
      - `greaterThanEqual` string — Value - returns all records with specified field greater than or equal to this value.
      - `lessThan` string — Value - returns all records with specified field less than to this value.
      - `lessThanEqual` string — Value - returns all records with specified field less than or equal to this value.
      - `contain` string — Value - returns all records with specified field containing this value.

## Response `200`

Success

- PaginatedResponseCustomerGetDto
  - `result` 'SUCCESS' | 'FAILURE' — The result of the action performed.
  - `data` CustomerGetDto[] — The data generated by the action performed.
    - `id` string, required — Id of the customer
    - `name` string, required — Name of the customer
    - `status` 'ACTIVE' | 'INACTIVE' | 'REMOVED', required — Status of the customer
    - `additionalContactName` string, nullable, required — Name of an additional contact for this customer
    - `businessName` string, nullable, required — Business name of the customer
    - `email` string, nullable, required — Email address of the customer
    - `ccEmails` string[], required — CC email addresses for invoices sent to this customer
    - `bccEmails` string[], required — BCC email addresses for invoices sent to this customer
    - `invoiceSettings` CustomerInvoiceSettingsGetDto, required — Invoice display settings for this customer
      - `invoicePrefix` string, nullable, required — Prefix used for invoice numbers for this customer
      - `showAdditionalContactName` boolean, required — Whether to show the additional contact name on invoices
      - `showBusinessName` boolean, required — Whether to show the business name on invoices
      - `showName` boolean, required — Whether to show the customer name on invoices
      - `showEmail` boolean, required — Whether to show the customer email on invoices
      - `showAddress` boolean, required — Whether to show the customer address on invoices
      - `showPhoneWork` boolean, required — Whether to show the work phone number on invoices
    - `address` AddressGetDto, nullable, required — Address of the vendor
      - `countryCode` 'USA' | 'CAN' | 'GBR' — Country Code of the address
      - `state` string — State/Province of the address
      - `city` string — City of the address
      - `zip` string — Zip/Postal code of the address
      - `phoneWork` string — The phone number
      - `address1` string — First line of the address
      - `address2` string — Second line of the address
    - `customData` JsonNode, nullable — Custom JSON in which you can store any data with max length of 2000 characters
      - `empty` boolean
      - `array` boolean
      - `null` boolean
      - `object` boolean
      - `float` boolean
      - `string` boolean
      - `number` boolean
      - `missingNode` boolean
      - `valueNode` boolean
      - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
      - `pojo` boolean
      - `integralNumber` boolean
      - `floatingPointNumber` boolean
      - `short` boolean
      - `int` boolean
      - `long` boolean
      - `double` boolean
      - `bigDecimal` boolean
      - `bigInteger` boolean
      - `textual` boolean
      - `boolean` boolean
      - `binary` boolean
      - `container` boolean
      - `embeddedValue` boolean
  - `cursor` ResponseCursor — Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.
    - `after` string — After cursor - Fetches entities after this cursor. Useful for paging forwards.
    - `before` string — Before cursor - Fetches entities before this cursor. Useful for paging backwards.

## Other responses

- `400` — Bad request
- `401` — Not authenticated
- `403` — Not authorized
- `404` — Endpoint not found
- `500` — Internal server error

---

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