Uptimeify Docs
Customers

Get Customer Details

Returns details of a specific customer.

GET /api/customers/:customerPublicId

packageDisplayName is the configured display label of the assigned organization package. It is not a normalized global enum and may contain organization-specific names such as aquisition_test.

Response

{
  "id": 101,
  "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88",
  "organizationId": 1,
  "name": "Customer A GmbH",
  "email": "contact@customer-a.de",
  "notificationPhoneNumber": "+491701234567",
  "notificationEmail": "alerts@customer-a.de",
  "packageId": 3,
  "packageDisplayName": "Growth",
  "status": "active",
  "customFields": {
    "internalReference": "KD-999"
  },
  "monthlyReportsEnabled": true,
  "notificationChannels": null,
  "notificationTargets": null,
  "notificationRules": null,
  "smsUsageCurrentMonth": 0,
  "updatedAt": "2023-05-15T10:00:00Z",
  "createdAt": "2023-05-15T10:00:00Z"
}

Common Errors

  • 400 Invalid Customer identifier
  • 401 Unauthorized
  • 403 Forbidden / Organization ID not found
  • 404 Customer not found

Create Customer

Creates a new customer and assigns an organization-defined package via packageType.

List Customers

Lists all customers of the organization.

On this page

ResponseCommon Errors