Skip to Content
Uptimeify Docs
Customers

List Customers

Lists all customers of the organization.

GET /api/customers

Query Parameters

  • organizationId (required): The ID of the organization.
  • fields (optional): Set to minimal to return a lightweight shape containing only id, publicId, name, status, and customFields. 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",
    "statusPageCount": 2
  },
  {
    "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",
    "statusPageCount": 0
  }
]

Status pages: every customer carries statusPageCount, the number of its status pages, published or not (the same count the package's status page limit is enforced against). In the paged form it is sortable with sortBy=statusPageCount, and with summary=1 each row's summary adds packageMaxStatusPages, the status pages per customer allowed by its package (null = unlimited).

List form: with envelope=items the list arrives as { items, total, page, perPage } and is always paged: page defaults to 1, perPage to 10 (at most 100), with the same filters and sorting as with page (search, status, packageTypes, sortBy, sortOrder, summary); packageOptions is left out. With fields=minimal every customer arrives in the short form as a single page. Without the parameter the endpoint still answers the current form, which is deprecated; { items, ... } becomes the default on 2027-01-18.

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.

On this page