Skip to main content
GET
/
customer
/
list
List customers
curl --request GET \
  --url https://start.aiotic.ai/customer/list \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "number": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "address": "<string>",
      "contact_person": "<string>",
      "phone_number": "<string>",
      "vat_number": "<string>",
      "email": "<string>",
      "coc_number": "<string>",
      "home_page": "<string>",
      "similarity": 123
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

X-API-Key
string
header
required

API key for authentication. Required on all endpoints except /healthcheck. Customer and product endpoints also accept a customer-specific API key.

Query Parameters

page
integer
default:1

Page number (starts at 1)

Required range: x >= 1
size
integer
default:100

Items per page

Required range: 1 <= x <= 1000

Response

Paginated list of customers

items
object[]
required

List of customer objects

total
integer
required

Total number of customers in the system

limit
integer
required

Maximum number of customers returned

offset
integer
required

Number of customers skipped (for pagination)