Get Customer

Get details about a single customer.

GET /customers/{id}

Get Customer

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/customers/{id} \
  --header 'X-Authorization: <api-key>'

200

{
  "id": 123,
  "external_id": "<string>",
  "channel": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[e-mail]",
  "phone": "<string>",
  "tags": [
    "<string>"
  ]
}

Authorizations

X-Authorization · string · header · required

API Scope: "Customers (read)"

Path Parameters

id · integer · required

The unique identifier for the customer, created by Loop.

Example:

67329889100573

Response

200

application/json

Success

id · integer<int64>

The unique identifier for the customer, created by Loop.

Example:

9007199254740991

external_id · string | null

The identifier used by an external source to identify the customer.

Example:

"71263csss-12uhsdfh-2138dja"

channel · string | null

The name of the channel associated with the customer.

Maximum string length: 64

Example:

"shopify"

first_name · string | null

The customer's given name.

Example:

"Edgar"

last_name · string | null

The customer's surname.

Example:

"Martinez"

email · string<email> | null

The customer's email address.

Example:

"[e-mail]"

phone · string | null

The customer's phone number.

Example:

"678-999-8212"

tags · (string | null)[]

An array of tags associated with the customer.

Example:

["FirstPurchase", "ReturnCustomer"]