Get a customer — API

GET/api/v1/customers/{id}

Scope: customers:read

One customer by id. Requires the "customers:read" scope.

Path parameters#

Field	Type	Description
`id`required	string	Awrora id (UUID) for the customer.

Example request#

bash

curl -X GET "https://your-site.awrora.app/api/v1/customers/id_8f2k3n" \
  -H "Authorization: Bearer $AWRORA_API_KEY"

Responses#

200The customer.
401Missing, invalid, revoked or expired API key — codes "api_key_missing", "api_key_invalid", "api_key_revoked", "api_key_expired".
403The API app is off, the plan does not include the API, or the key lacks the required scope — codes "app_not_enabled", "plan_upgrade_required", "insufficient_scope" (the last carries "required_scope").
404No such resource. The same response is returned for a resource that belongs to another organization — code "not_found".
429Rate limit exceeded — code "rate_limited". See the x-ratelimit-* headers.
500Something went wrong on our side — code "internal_error".

Response 200

Field	Type	Description
`id`required	string	Awrora id (UUID) for the customer record.
`name`required	string	Customer name.
`email`required	string	Customer email. Unique within the organization.
`phone`required	string \| null	Phone number, or null.
`tags`required	string[]	Merchant-defined tags. May be empty.
`email_subscription`required	boolean	True when the customer has opted in to marketing email.
`created_at`required	string	ISO 8601 timestamp with offset.

200 response

{
  "id": "res_8f2k3n",
  "name": "string",
  "email": "anna@example.com",
  "phone": "string",
  "tags": [
    "string"
  ],
  "email_subscription": true,
  "created_at": "string"
}