Skip to content

Retrieve a customer​

GET
/customers/{customer_id}

Authorizations​

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters​

Path Parameters

customer_id*

Customer identifier

Typestring
Required

Responses​

customer returned

application/json
JSON
{
"id": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"language": "string",
"number": "string",
"slug": "string",
"status": "string",
"groups": [
"string"
],
"url": "string",
"verified_email": true,
"verified_at": "string",
"suspended": true,
"suspended_at": "string",
"last_activity_at": "string",
"authentication_token": "string",
"password_updated_at": "string",
"confirmation_token": "string",
"roles": [
"string"
],
"addresses": [
{
"id": "string",
"firstname": "string",
"lastname": "string",
"company": "string",
"address1": "string",
"address2": "string",
"zip": "string",
"city": "string",
"country": "string",
"phone": "string",
"default_billing": true,
"default_shipping": true
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​