GET
/
v1
/
customers
/
by-external-id
/
{externalId}
Fetch customer by external ID
curl --request GET \
  --url https://api.useaira.com/v1/customers/by-external-id/{externalId} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "<string>",
  "externalId": "cust_1234567890abcdef",
  "name": "Acme Inc.",
  "customFields": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  }
}

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

​
externalId
string
required

An optional external identifier of the customer from the external system, used throughout the system to identify the customer. This field can not be updated.

Response

The request was successfully processed and the customer information is returned.

​
id
string
required

The unique identifier of the customer in our system.

​
externalId
string
required

An optional external identifier of the customer from the external system, used throughout the system to identify the customer. This field can not be updated.

Example:

"cust_1234567890abcdef"

​
name
string
required

The name of the customer.

Example:

"Acme Inc."

​
customFields
object

Custom fields that can be associated with the customer. The fields must be previously created in the system before they can be used.

Example:
{
  "custom_field_1": "value1",
  "custom_field_2": "value2"
}