PApaddlehq
Customers

List customers

Changed on

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.

get/customers

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Query parameters

idstring[]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

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.

emailstring[]

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.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

statusStatusQuery[]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

searchstring

Return entities that match a search query. Searches id, name, and email fields. Use the email query parameter for precise matching of email addresses.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
      "email": "test@paddle.com",
      "custom_data": {
        "customer_reference_id": "abcd1234"
      },
      "created_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z",
      "import_meta": {
        "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
        "imported_from": "paddle_classic"
      }
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes

  • v1e1ac347eb3c5Revision changes
    • info

      added the new optional header request parameter Skip-Count

  • v19ba8be0f2006Revision changes
    • breaking

      for the query request parameter status, default value active was added

    • breaking

      the // response property's maxLength was unset from 320 for the response status

    • breaking

      the // response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the // response's property type changed from string to no type, and format from email to no format for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the response optional property // became not read-only for the status

    • info

      the response optional property // became not read-only for the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the active enum value from the // response property for the response status

    • info

      removed the archived enum value from the // response property for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      the // response's property pattern ^ctm_[a-z\d]{26}$ was removed for the status