Skip to main content
GET
/
api
/
v1
/
customers
List all customers
curl --request GET \
  --url https://api.config.money/api/v1/customers \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "type": "phone",
      "value": "<string>",
      "account_number": "<string>",
      "sort_code": "<string>"
    }
  ],
  "total": 123
}

​
List Customers

Retrieve a list of all customers associated with your merchant account.
This endpoint requires API key authentication. Include your API key in the Authorization header.

​
Endpoint

GET /api/v1/customers

​
Headers

NameTypeDescription
AuthorizationstringYour API key in the format Bearer YOUR_API_KEY

​
Query Parameters

ParameterTypeDescription
limitintegerNumber of records to return (default: 10, max: 100)
offsetintegerNumber of records to skip (default: 0)

​
Response

​
Success Response (200 OK)

{
  "data": [
    {
      "id": "cust_123456789",
      "type": "phone",
      "value": "+447911123456",
      "created_at": "2024-03-20T10:00:00Z"
    },
    {
      "id": "cust_987654321",
      "type": "bank_account",
      "account_number": "12345678",
      "sort_code": "123456",
      "created_at": "2024-03-20T11:00:00Z"
    }
  ],
  "total": 2
}

​
Error Responses

​
401 Unauthorized

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}

​
429 Too Many Requests

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests"
  }
}

​
Examples

​
List All Customers

curl -X GET https://api.config.money/api/v1/customers \
  -H "Authorization: Bearer YOUR_API_KEY"

​
List Customers with Pagination

curl -X GET "https://api.config.money/api/v1/customers?limit=20&offset=40" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authorizations

​
Authorization
string
header
required

API key in the format 'Bearer YOUR_API_KEY'

Query Parameters

​
limit
integer
default:10

Number of records to return

​
offset
integer
default:0

Number of records to skip

Response

200 - application/json

List of customers

​
data
object[]
​
total
integer