Skip to main content
GET
/
customers
{
  "total": 123,
  "offset": 123,
  "limit": 123,
  "data": [
    {
      "type": "<string>",
      "id": "<string>",
      "createdAt": "<string>",
      "lastModifiedAt": "<string>",
      "status": "CUSTOMER_CREATED",
      "policies": [
        "<string>"
      ],
      "invoices": [
        "<string>"
      ],
      "paymentMode": "DIRECT_DEBIT",
      "customFields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "name": "<string>",
      "preferredPaymentMethodId": "<string>"
    }
  ]
}

Query Parameters

whenAt
string

Optional: the whenAt datetime

simulatedAt
string

Optional: the simulatedAt datetime

branchId
string

Optional: the branchId

offset
number
default:0

the pagination offset

pageSize
number
default:50

the pagination page size

Response

200 - application/json
total
number
required

Total number of customers

offset
number
required

Offset used for pagination

limit
number
required

Page size used for pagination

data
object[]
required

List of customers