Customers

Get a customer

View as Markdown

Fetches one customer by their Perkss id. To look a customer up by your own identifier, use GET /api/v1/customers?externalId=… instead.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customerIdstringRequired

Perkss customer id (UUID) — the id returned by customer create/list.

Response

idstring

Perkss customer id (UUID). Use it for every customer-scoped call.

externalIdstring or null

Your own identifier for this customer — unique per company when set; null when never supplied.

firstNamestring
lastNamestring
emailstring
phonestring

E.164. Phone is the customer identity within your company — inputs in any parseable format are canonicalized to this form.

createdAtstring
ISO 8601 creation timestamp.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error