Sweet Spot API

Command Palette

Search for a command to run...

GET/v1/customers/{id}

Retrieves a single customer by their ID. Use this endpoint to fetch detailed customer information for display or editing. The response includes customer data and associated user information. Organization members can access customers who have checkouts with their organization's products. Requires CustomerRead permission on the target customer.

Parameters
Request parameters for this endpoint
NameLocationTypeRequiredDescription
idpathstringRequiredCustomer ID to retrieve
Response Data
Fields returned in the response

Always Present

NameTypeDescription
createdAt
string (date-time)
Timestamp when the customer record was created
creditStatus
Current credit check status (unknown, passed, or failed)
id
CustomerPubId
Public-facing unique identifier for the customer
identityVerificationStatus
Identity verification status (none, pending, processing, verified, failed)
updatedAt
string (date-time)
Timestamp when the customer record was last updated
userId
UserId
User account associated with this customer

Optional

NameTypeDescription
address1
string
Primary street address line
address2
string
Optional secondary address line (apartment, suite, etc.)
city
string
City name
country
string
Country code (ISO format)
creditIpAddress
string
IP address used when performing the credit check
creditTimestamp
string
Timestamp when the credit check was performed
phone
string
Phone number of the customer
state
string
State or province code
stripeId
string
Stripe customer ID for payment processing (production)
stripeSandboxId
string
Stripe customer ID for payment processing (sandbox)
stripeVerificationSessionId
string
Stripe Identity verification session ID
zip
string
Postal or ZIP code
Retrieves a single customer by their ID. Use this endpoin... | Sweet Spot API Documentation