Retrieves a list of customers with optional pagination, s...

GET/v1/customers

Retrieves a list of customers with optional pagination, sorting, and filtering. Use this endpoint to display customer lists in admin interfaces or search for specific customers. Supports filtering by organization (via checkout relationships), email (partial match), and name (partial match). Results are automatically filtered based on the authenticated user's permissions. Requires CustomerRead capability.

Parameters

Request parameters for this endpoint

Name	Location	Type	Required	Description
organizationId	query	string	Optional	Filter by organization ID (finds customers via checkouts)
email	query	string	Optional	Search by email (partial match, case-insensitive)
name	query	string	Optional	Search by name (searches first_name, last_name, and full_name)
offset	query	integer	Optional	Number of items to skip for pagination
limit	query	integer	Optional	Maximum number of items to return per page
userId	query	string	Optional	Filter customers by user ID

Response Data

Fields returned in the response

Always Present

Name	Type	Description
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

Name	Type	Description
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

GET/v1/customers

Request

curl https://api.thesweetspot.com/v1/customers \
  -H "Content-Type: application/json" \
  -G -d "organizationId=id_123&email=user@example.com&name=string&offset=0&limit=10&userId=123"

Response

[
  {
    "userId": null
  }
]