Sign in
customer

get/api/v1/customers

Query parameters

per_pageinteger

Specifies the max number of results in a page

pageinteger

The page to return, starting at index 0

searchstring

Filter customers by search term (part of name, alias or email)

Response

List of customers

Example response

{
  "data": [
    {
      "bank_account_id": "ba_7n42DGM5Tflk9n8mt7Fhc7",
      "billing_address": {
        "country": "US"
      },
      "id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
      "invoicing_entity_id": "ive_7n42DGM5Tflk9n8mt7Fhc7",
      "shipping_address": {
        "address": {
          "country": "US"
        }
      }
    }
  ]
}

Changes