Skip to main content
GET
Get a platform customer
Fetch one platform customer by its id. Use this to check a customer’s current details or isActive state before filing for them.

Request example

Response example

Errors

  • 404 when no customer with that id belongs to your account.

Next steps

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The customer ID

Response

Customer response

id
string

Unique identifier of the platform customer

name
string
email
string<email>
type
enum<string>
default:customer
Available options:
customer
companyName
string
address
string
platformId
string

Platform user ID that owns this customer

isActive
boolean
createdAt
string<date-time>
updatedAt
string<date-time>