Sign in

v47

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-013871777.1 KB
Customer

Retrieve a Customer

Retrieve a Customer Object by its id.

post/api/service/customer/retrieve

Request body

idstring required

The id of the customer

Response

Successful response

idstring required

The id of the customer

emailstring

The email address of the customer

emailAddressstring

Deprecated. Use the customer.email instead

phonestring

The phone number of the customer

fullNamestring

The full name or business name of the customer

dateOfBirthstring

Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'. Reference: https://en.wikipedia.org/wiki/ISO_8601

deletedboolean

Indicates whether the customer was deleted

deletedAtstring date-time

The customer deletion timestamp

metadataobject

A collection of key-value pairs that can be associated with an object to store custom data in a structured manner. This allows you to attach arbitrary information to enhance the object with additional context or properties. To clear the metadata, send an empty object.