List customers
Returns a paginated list of customers. Use the query parameters to page through results.
By default, Paddle returns customers that are active. Use the status query parameter to return customers that are archived.
Query Parameters
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.
Return entities that exactly match the specified email address. Use a comma-separated list to specify multiple email addresses. Recommended for precise matching of email addresses.
Return only the IDs specified. Use a comma-separated list to get multiple entities.
Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].
Valid fields for ordering: id.
Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.
Default: 50; Maximum: 200.
Return entities that match a search query. Searches id, name, and email fields. Use the email query parameter for precise matching of email addresses.
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Response
Represents a customer entity.
Unique Paddle ID for this customer entity, prefixed with ctm_.
Full name of this customer. Required when creating transactions where collection_mode is manual (invoices).
Email address for this customer.
Whether this customer opted into marketing from you. Set to true by Paddle where a customer checks the marketing consent box when using Paddle Checkout; false otherwise.
Whether this entity can be used in Paddle.
Your own structured key-value data.
Valid IETF BCP 47 short form locale tag. If omitted, defaults to en.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Import information for this entity. null if this entity is not imported.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Keys used for working with paginated results.