---
title: "List Customers"
method: GET
path: "/api/customers"
tags: ["Customers"]
---

# List Customers

`GET /api/customers`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/customers`
- Auth: HTTP bearer

GET /api/customers

## Query parameters

- `Response` string
- `organizationId` integer
- `fields` 'minimal'
- `page` integer
- `perPage` integer
- `search` string
- `status` 'active' | 'inactive'
- `packageTypes` string
- `sortBy` string
- `sortOrder` 'asc' | 'desc'
- `summary` '0' | '1' | 'true' | 'false'

## Response `200`

OK

- union: Without page: every customer as an array (with fields=minimal a short form); with page: the paged shape.
  - object
    - `items` object[], required
      - `id` integer, required
      - `publicId` string, uuid, required
      - `organizationId` integer, required
      - `name` string, required
      - `email` string, nullable, required
      - `customFields` object, nullable, required
      - `packageId` integer, nullable, required
      - `status` 'active' | 'inactive', required
      - `cancellationDate` string, date-time, nullable, required
      - `cancelledAt` string, date-time, nullable, required
      - `notificationEmail` string, nullable, required
      - `createdAt` string, date-time, required
      - `monitorCount` integer, required
      - `managedMonitorCount` integer, required
      - `unmanagedMonitorCount` integer, required
      - `dnsblMonitorCount` integer, required
      - `packageDisplayName` string, nullable, required
      - `summary` object: With summary=1.
        - `websiteMonitors` integer, required
        - `packageMaxUrls` integer, nullable, required
        - `uptime30d` number, nullable, required: Percent, 0..100.
        - `incidents30d` integer, required
    - `total` integer, required
    - `page` integer, required
    - `perPage` integer, required
    - `packageOptions` object[]: Page 1 only: package filter options over all customers in scope.
      - `label` string, required
      - `packageTypes` string[], required
  - object[]
    - `id` integer, required
    - `publicId` string, uuid, required
    - `organizationId` integer, required
    - `name` string, required
    - `email` string, nullable, required
    - `customFields` object, nullable, required
    - `packageId` integer, nullable, required
    - `status` 'active' | 'inactive', required
    - `cancellationDate` string, date-time, nullable, required
    - `cancelledAt` string, date-time, nullable, required
    - `notificationEmail` string, nullable, required
    - `createdAt` string, date-time, required
    - `monitorCount` integer, required
    - `managedMonitorCount` integer, required
    - `unmanagedMonitorCount` integer, required
    - `dnsblMonitorCount` integer, required
    - `packageDisplayName` string, nullable, required
    - `packageConfig` object, nullable, required
      - `displayName` string, nullable, required
  - object[]
    - `id` integer, required
    - `publicId` string, uuid, required
    - `name` string, required
    - `status` 'active' | 'inactive', required
    - `customFields` object, nullable, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)