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
NameTypeRequiredDescription
address1
string
OptionalPrimary street address line
address2
string
OptionalOptional secondary address line (apartment, suite, etc.)
city
string
OptionalCity name
country
string
OptionalCountry code (ISO format)
createdAt
string (date-time)
RequiredTimestamp when the customer record was created
creditIpAddress
string
OptionalIP address used when performing the credit check
creditStatus
RequiredCurrent credit check status (unknown, passed, or failed)
creditTimestamp
string
OptionalTimestamp when the credit check was performed
id
CustomerPubId
RequiredPublic-facing unique identifier for the customer
phone
string
OptionalPhone number of the customer
state
string
OptionalState or province code
stripeId
string
OptionalStripe customer ID for payment processing (production)
stripeSandboxId
string
OptionalStripe customer ID for payment processing (sandbox)
updatedAt
string (date-time)
RequiredTimestamp when the customer record was last updated
userId
UserId
RequiredUser account associated with this customer
zip
string
OptionalPostal or ZIP code