Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview

List customers

List filters are passed as query parameters — see the conventions in the introduction.

GET/customer
Authorization
AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Responses
200

OK.

Array of Customer
idinteger

Internal customer id (read-only, autoassigned)

customerSidstring

Autogenerated user-friendly id, e.g. Customer-95001 (read-only, autoassigned)

emailstring

Customer email

customIdstring

Custom id specified by user

firstNamestring

First name

lastNamestring

Last name

companyNamestring

Company name

profitCenterNamestring

Profit center name

departmentstring

Department

customerGroupNamestring

Customer group name

accountTypestring

Account type: "business" or "private" (create-only, cannot be updated)

phonestring

Phone number

customerStatusNamestring

Customer status name

billingAddressesany[]

Non-empty array of billing address objects: id (read-only), firstName, lastName, countryCode, address, addressSecondLine, postCode, city, stateCode, company, companyNumber, email, phone, isDefault (boolean), department, vatId, fax

shippingAddressesany[]

Non-empty array of shipping address objects: id (read-only), firstName, lastName, countryCode, address, addressSecondLine, postCode, city, stateCode, company, companyNumber, email, phone, isDefault (boolean), department, deliveryInstructions, fax

createdAtstring

Creation timestamp (ISO date, read-only, autoassigned)

regionsany[]

Array of region objects: id, name (name is read-only)

401

Authentication failed. All causes return this identical response.

codeinteger
messagestring
typestring
default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger
messagestring
typestring
Try it
Server
Authorization
Request
curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/customer' \
  -H 'Authorization: YOUR_API_KEY'
Response
[
  {
    "id": 2225,
    "email": "sviatoslav.khizhniak@amfg.ai",
    "customerSid": "Customer-95001",
    "customId": "CLIENT-0001",
    "firstName": "Sviatoslav",
    "lastName": "Khizhniak",
    "accountType": "private",
    "profitCenterName": "Main",
    "companyName": "AMFG",
    "department": "123",
    "customerGroupName": "General Customers",
    "phone": "+380931234567",
    "customerStatusName": "New",
    "createdAt": "2022-08-23T10:14:30.455Z",
    "billingAddresses": [
      {
        "id": "232",
        "firstName": "Sviatoslav",
        "lastName": "Khyzhniak",
        "countryCode": "UA",
        "address": "Geroyiv Dnipra St, 47",
        "addressSecondLine": "",
        "postCode": "02222",
        "city": "Kyiv",
        "stateCode": "",
        "company": "AMFG",
        "email": "sviatoslav.khizhniak@amfg.ai",
        "phone": "+380931234567",
        "isDefault": true
      }
    ],
    "shippingAddresses": [
      {
        "id": "233",
        "firstName": "Sviatoslav",
        "lastName": "Khyzhniak",
        "countryCode": "UA",
        "address": "Geroyiv Dnipra St, 47",
        "addressSecondLine": "",
        "postCode": "02222",
        "city": "Kyiv",
        "stateCode": "",
        "company": "AMFG",
        "email": "sviatoslav.khizhniak@amfg.ai",
        "phone": "+380931234567",
        "isDefault": true,
        "deliveryInstructions": ""
      }
    ],
    "regions": [
      {
        "id": 1,
        "name": "Region name"
      }
    ]
  }
]