Skip to main content
GET
Get a customer

Authorizations

Authorization
string
header
required

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

Path Parameters

customer_id
string
required
Maximum string length: 50
Example:

"01BX5ZZKBKACTAV9WEVGEMMVRZ"

Response

Response for Get customer requests

Structure of customer

id
string
required

Identifier of customer

Maximum string length: 50
togaiCustomerId
string
required

Unique identifier of customer

name
string
required

Name of the Customer

Required string length: 3 - 255
primaryEmail
string
required

Primary email of the customer

Maximum string length: 320
billingAddress
string
required

billing address of the customer

Maximum string length: 1000
Example:

"201 Boulevard, WA 53123"

address
object
required

billing address of the customer

status
enum<string>
required

Status of the customer

Available options:
ACTIVE,
ARCHIVED
Example:

"ACTIVE"

createdAt
string<date-time>
required
updatedAt
string<date-time>
required