Customer details
Show customer details
- The
nameandemailattributes are kept in sync with the relatedcontactresource - The
external_user_idattribute may be used as a customer reference in an external system
Customer Attributes
name(string) - The customer’s full name. This is a required field and can be either user-provided or auto-generated from their email address if left blank.email(string) - The customer’s email address. This is a required field and must be unique within a site. It’s automatically downcased and stripped of whitespace. Used for authentication and communication.avatar(string) - A URL to the customer’s profile image. Can be either a custom uploaded avatar or falls back to Gravatar. If not set, defaults to a blank image.external_user_id(string) - An optional external identifier that can be used to link the customer to external systems. Must be unique within a site.public_bio(string) - A text field containing the customer’s public biography or description. This is optional and can be displayed in community/social features.public_location(string) - A text field for the customer’s public location information. Optional field used for community/social features.public_website(string) - The customer’s website URL. This is validated to ensure it’s a proper URL format and is transformed to ensure proper formatting.socials(object) - A collection of the customer’s social media links and profiles.net_revenue(string) - The total revenue generated by this customer through their purchases. This is calculated from their successful payment transactions.sign_in_count(integer) - A counter tracking how many times the customer has signed into their account.last_request_at(string) - Timestamp of the customer’s most recent activity or request. Used to track user engagement and activity.bounced_at(string) - Timestamp indicating when the customer’s email started bouncing. This is reset if the email address is changed.created_at(string) - Timestamp when the customer record was created.updated_at(string) - Timestamp when the customer record was last updated.
Include Related Resources
Use the include parameter to include related resources:
Include offers and products
GET /v1/customers/123?include=contact,offers,products
Response will include related resources
Sparse Fields
Use the fields[customers] parameter to request only specific attributes:
Only return name and email attributes
GET /v1/customers/123?fields[customers]=name,email
Response will only include requested fields
Using Multiple Parameters Together
You can combine filtering, sparse fields, pagination and search in a single request:
GET /v1/customers/123?include=products&fields[customers]=name&fields[product]=title
Response will include related resources with sparse fields
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Partial attributes as specified, e.g. fields[customers]=name,email
Should be ignored when include parameter is missing
Should be ignored when include parameter is missing