Get Customer Resource

Retrieves a customer resource by its external ID. Can include reference fields to resolve and filter by field values.

GET /api/resources/customers/{externalId}

Get Customer Resource

cURL

curl --request GET \
  --url https://api.embedreach.com/api/resources/customers/{externalId}

200

{
  "success": true,
  "message": "<string>"
}

Headers

reach-tenant-id · string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

externalId · string · required

The external ID of the customer resource to retrieve

Query Parameters

include · string

Comma-separated list of reference ($ref) fields to include in the response. (Supports nested references with dot notation)

referenceFormat · enum<string> · default: object

How to return reference fields: object = { type, id } (default), id = plain id or array of ids. "id" is recommended and will become the default in a future version.

Available options: object, id

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes