Skip to main content
GET
/
api
/
v1
/
business
/
customers
List customers
curl --request GET \
  --url http://localhost:3001/api/v1/business/customers \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "customers": [
      {
        "customerId": "<string>",
        "email": "<string>",
        "totalPayments": 123,
        "totalSpent": 123,
        "userId": "<string>",
        "firstName": {},
        "lastName": {},
        "defaultPaymentMethod": {}
      }
    ],
    "pagination": {
      "page": 123,
      "limit": 123,
      "total": 123,
      "totalPages": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.useaxra.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

x-api-key
string
required

Query Parameters

page
number
limit
number

Response

OK

success
boolean
required
Example:

true

data
object
required