Skip to main content
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": "705faf65-9c8b-4053-8c0b-2021281ce83f",
      "name": "Acme Inc.",
      "customFields": {
        "customField1": "value1",
        "customField2": [
          "value2",
          "value3"
        ]
      }
    }
  ],
  "hasMore": true
}

Authorizations

X-API-KEY
string
header
required

API Key Authentication.

Query Parameters

offset
number
default:0
Required range: x >= 0
limit
number
default:100
required
Required range: 1 <= x <= 100

Response

200 - application/json

Default Response

items
object[]
required

A list of items.

hasMore
boolean
required

Indicates if there are more items to fetch.