Skip to main content
GET
/
v1
/
customers
/
external
/
{customer_external_id}
Get a customer
curl --request GET \
  --url https://api.dev.bsa.ai/v1/customers/external/{customer_external_id} \
  --header 'Authorization: Bearer <token>'
Two equivalent forms. Prefer the externalId form — it lets you read a customer by the reference you already store, with no client-side mapping to a numeric LMS id. See Addressing a customer.

​
Path parameters

​
customer_external_id
string
required
The customer’s partner-supplied externalId (the value you sent on create). On the alternative /v1/customers/{customer_id} form, this is the numeric LMS id instead.

​
Examples

# By externalId (recommended)
curl -sf "$BASE/v1/customers/external/ext-ada-001" \
  -H "Authorization: Bearer $TOKEN"

# Same effect, by LMS id
curl -sf "$BASE/v1/customers/42" \
  -H "Authorization: Bearer $TOKEN"

​
Response

200 OK returns the full customer object.

​
Errors

CodeWhen
not_foundNo customer exists with that externalId or id
invalid_argumentcustomer_id is not a valid numeric identifier (only applies to the LMS-id form)