Skip to main content
GET
Get customer

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id
string
required

Customer ID

Response

OK

Customer response object containing all customer information

address_city
string

AddressCity is the city of the customer's address

address_country
string

AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)

address_line1
string

AddressLine1 is the first line of the customer's address

address_line2
string

AddressLine2 is the second line of the customer's address

address_postal_code
string

AddressPostalCode is the postal code of the customer's address

address_state
string

AddressState is the state of the customer's address

contact
string

Contact is an optional contact number for the customer (e.g. phone)

created_at
string<date-time>
created_by
string
email
string

Email is the email of the customer

environment_id
string

EnvironmentID is the environment identifier for the customer

external_id
string

ExternalID is the external identifier for the customer

id
string

ID is the unique identifier for the customer

integrations
object[]
metadata
object

Metadata

name
string

Name is the name of the customer

status
enum<string>
Available options:
published,
deleted,
archived
tenant_id
string
timezone
string

Timezone is the customer's IANA timezone name (e.g. "Asia/Kolkata"). Defaults to "UTC". Inherited by subscriptions at creation time.

updated_at
string<date-time>
updated_by
string