Skip to navigation
TIANKII API - API KeyCustomers

Get customer

View as Markdown

Get customer by ID

Fetches a single customer by its id, scoped to the authenticated merchant’s store.

Authentication

  • Send the merchant API key in the x-api-key header (alias x-account-api-key).
  • Requires the scope: Merchant.customer.read.
  • Optionally scope the key with x-application-account-id (alias x-account-id) or the application_account_id / account_id query param.

Path params

  • id: the customer UUID.

Behavior

  • Only returns customers belonging to the caller’s store. If the customer does not exist for that store, responds 404 Not Found ("Customer with ID \"<id>\" not found.").

Notas: Store-scoped lookup: a customer belonging to another store returns 404, not 403. Related: PATCH /v1/customers/:id, DELETE /v1/customers/:id.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired

The customer’s unique identifier (UUID). Must belong to the authenticated store.

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.