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

# Query Customers

`GET /v2/customers`

Query all customers

## Query parameters

- `searchKeyWord` string
- `number` string
- `groupId` string, uuid
- `categoryId` string, uuid
- `lastChangeFrom` string, date-time
- `lastChangeTo` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Headers

- `x-tenant-id` string, uuid, required
- `x-runas` string
- `x-companyid` string

## Response `200`

Returns all customer, can be filtered by searchKeyWord or categoryId.

- JTLWawiRestContractsModelsPagedListOfJTLWawiRestContractsModelsV1CustomerCustomer — Represents a paginated list of items
  - `totalItems` integer — Gets or sets the total number of items available in the data source.
  - `pageNumber` integer — Gets or sets the current page number in the paginated list.
  - `pageSize` integer — Gets or sets the number of items per page in the paginated list.
  - `items` JTLWawiRestContractsModelsV1CustomerCustomer[] — Gets or sets the collection of items contained in the paged list.
    - `id` string, uuid — Represents a unique key for identifying a customer in the JTL system.
    - `number` string — The customer's number.
    - `customerGroupId` string, uuid
    - `billingAddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `shipmentaddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `customAddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `otherAddresses` JTLWawiRestContractsModelsV1CustomerOtherAddresses — Model Class: OtherAddresses
      - `otherBillingAddresses` JTLWawiRestContractsModelsV1CommonAddress[] — All other non-default billing addresses of the customer.
        - `id` string, uuid
        - `company` string — Description of the Company.
        - `company2` string — Additional company information
        - `formOfAddress` string — Customer form of address
        - `title` string — Official title
        - `firstName` string — Customer first name
        - `lastName` string — Customer last name
        - `street` string — Street name in the customer's address
        - `address2` string — Additional address information
        - `postalCode` string — Postal code of the customer's address
        - `city` string — Name of city in the customer's address
        - `state` string — Name of state in the customer's address
        - `countryIso` string — Country ISO code
        - `vatID` string — Supplier VAT ID number
        - `phoneNumber` string — Landline phone number
        - `mobilePhoneNumber` string — Mobile phone number
        - `emailAddress` string — Email address
        - `fax` string — Fax number
      - `otherShippingAddresses` JTLWawiRestContractsModelsV1CommonAddress[] — All other non-default shipping addresses of the customer.
        - `id` string, uuid
        - `company` string — Description of the Company.
        - `company2` string — Additional company information
        - `formOfAddress` string — Customer form of address
        - `title` string — Official title
        - `firstName` string — Customer first name
        - `lastName` string — Customer last name
        - `street` string — Street name in the customer's address
        - `address2` string — Additional address information
        - `postalCode` string — Postal code of the customer's address
        - `city` string — Name of city in the customer's address
        - `state` string — Name of state in the customer's address
        - `countryIso` string — Country ISO code
        - `vatID` string — Supplier VAT ID number
        - `phoneNumber` string — Landline phone number
        - `mobilePhoneNumber` string — Mobile phone number
        - `emailAddress` string — Email address
        - `fax` string — Fax number
      - `otherCustomerAddresses` JTLWawiRestContractsModelsV1CommonAddress[] — All other non-billing and non-shipping addresses of the customer.
        - `id` string, uuid
        - `company` string — Description of the Company.
        - `company2` string — Additional company information
        - `formOfAddress` string — Customer form of address
        - `title` string — Official title
        - `firstName` string — Customer first name
        - `lastName` string — Customer last name
        - `street` string — Street name in the customer's address
        - `address2` string — Additional address information
        - `postalCode` string — Postal code of the customer's address
        - `city` string — Name of city in the customer's address
        - `state` string — Name of state in the customer's address
        - `countryIso` string — Country ISO code
        - `vatID` string — Supplier VAT ID number
        - `phoneNumber` string — Landline phone number
        - `mobilePhoneNumber` string — Mobile phone number
        - `emailAddress` string — Email address
        - `fax` string — Fax number
    - `paymentSettings` JTLWawiRestContractsModelsV1CustomerPaymentSettings — Model Class: PaymentSettings
      - `paymentMethodId` string, uuid
      - `discount` number — The indicated discount, if any.
      - `paymentTarget` integer — The payment target in days.
      - `creditLimit` integer — The customer's credit limit.
      - `stopPaymentRequest` boolean — Option to stop payment requests.
    - `customerSince` string, date-time — Date since they have been a customer.
    - `lastChange` string, date-time — Date of the last customer's data change.
    - `languageIso` string — The customer's language.
    - `internalCompanyId` string, uuid — Represents a key for identifying a firm within the application.
    - `customerCategoryId` string, uuid
    - `taxIdentificationNumber` string — The customer's tax identification number.
    - `accountsReceivableNumber` integer — The customer's accounts receivable number.
    - `commercialRegisterNumber` string — The customer's commercial register number.
    - `website` string — The customer's website.
    - `initialContact` string — The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.
    - `ebayUsername` string — The customer's eBay username.
    - `birthday` string, date-time — The customer's date of birth.
    - `isLocked` boolean — The customer's locked status for online shop sales channels.
    - `isCashRegisterBased` boolean — States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example.
  - `totalPages` integer — Gets the total number of pages based on the total number of items and the page size.
  - `hasPreviousPage` boolean — Gets a value indicating whether there is a previous page available in the paginated list.
  - `hasNextPage` boolean — Gets a value indicating whether there is a next page available.
  - `nextPageNumber` integer — Gets the number of the next page if there is one; otherwise, returns the total number of pages.
  - `previousPageNumber` integer — Gets the number of the previous page. If there is no previous page, it returns 1.

## Other responses

- `401`
- `402` — No licence available or the app has not been authorised by JTL.

---

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