GET
/
v1
/
customers
/
List customers
curl --request GET \
  --url https://api.useaira.com/v1/customers/ \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "externalId": "cust_1234567890abcdef",
      "name": "Acme Inc.",
      "customFields": {
        "custom_field_1": "value1",
        "custom_field_2": "value2"
      }
    }
  ],
  "hasMore": true
}

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Query Parameters

​
limit
number
default:100
required

The maximum number of customers to fetch.

Required range: 1 <= x <= 100
​
offset
number
default:0

The offset to start fetching customers from.

Required range: x >= 0
​
search
string

A search query to filter customers by name or externalId.

Response

200 - application/json

Default Response

The response is of type object.