Customers
List Customers
Lists all customers of the organization.
GET /api/customers
Query Parameters
organizationId(required): The ID of the organization.fields(optional): Set tominimalto return a lightweight shape containing onlyid,publicId,name,status, andcustomFields. The monitor counts and package details are omitted, and the response is much smaller. Useful for populating pickers/dropdowns.
Response
With fields=minimal:
[
{
"id": 101,
"publicId": "cus_9f3a…",
"name": "Customer A GmbH",
"status": "active",
"customFields": { "region": "EU" }
}
]Default response:
[
{
"id": 101,
"organizationId": 1,
"name": "Customer A GmbH",
"email": "contact@customer-a.de",
"packageId": 4,
"packageDisplayName": "Business",
"status": "active",
"cancellationDate": null,
"notificationEmail": "alerts@customer-a.de",
"createdAt": "2023-05-15T10:00:00Z"
},
{
"id": 102,
"organizationId": 1,
"name": "StartUp XY",
"email": "info@startup-xy.com",
"packageId": 1,
"packageDisplayName": "Essential",
"status": "marked_for_cancellation",
"cancellationDate": "2024-12-31T23:59:59Z",
"createdAt": "2023-06-20T14:30:00Z"
}
]Note: The list response intentionally no longer exposes the raw packageType. Use packageDisplayName for display and packageId for technical mapping. packageDisplayName comes from the assigned organization package config and may therefore be organization-specific.