---
title: "List Websites"
method: GET
path: "/api/websites"
tags: ["Websites"]
---

# List Websites

`GET /api/websites`

## Request

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

GET /api/websites

## Query parameters

- `search` string
- `customerId` string
- `monitoringTypes` string
- `monitoringType` string
- `excludeMonitoringType` 'combined' | 'http_status' | 'ssl_check' | 'playwright' | 'heartbeat' | 'dns'
- `httpMethods` string
- `statuses` string
- `sortBy` 'name' | 'url' | 'customer' | 'status' | 'management' | 'monitoringType' | 'createdAt' | 'monitorStatus' | 'avgResponseDay' | 'avgResponseMonth' | 'avgResponseYear' | 'uptimeDay' | 'uptimeMonth' | 'uptimeYear' | 'upSince' | 'httpMethod'
- `sortOrder` 'asc' | 'desc'
- `page` integer
- `perPage` integer
- `tags` string
- `organizationId` integer
- `skipMetrics` '0' | '1' | 'true' | 'false'

## Response `200`

OK

- object
  - `items` object[], required
    - `id` integer, required
    - `publicId` string, uuid, required
    - `customerId` integer, required
    - `name` string, required
    - `url` string, required: heartbeat://<token> for heartbeat monitors, playwright://... for scripted ones.
    - `monitoringType` 'combined' | 'http_status' | 'ssl_check' | 'playwright' | 'heartbeat' | 'dns', required
    - `dnsConfig` object, required
    - `checkInterval` integer, required: Minutes.
    - `timeoutSeconds` integer, required
    - `expectedStatusCodes` string, nullable, required
    - `searchTerm` string, nullable, required
    - `playwrightDevice` string, nullable, required
    - `playwrightViewportWidth` integer, nullable, required
    - `playwrightViewportHeight` integer, nullable, required
    - `playwrightRetries` integer, required
    - `playwrightTimeoutMs` integer, required
    - `allowedCheckCountryCodes` string[], nullable, required: ISO country codes of the allowed check locations; null = all.
    - `customFields` object, nullable, required
    - `authMode` 'none' | 'authorization_header' | 'basic', required
    - `basicAuthUsername` string, nullable, required
    - `httpMethod` 'GET' | 'QUERY' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS', nullable, required
    - `followRedirects` boolean, nullable, required
    - `cookieHandling` 'none' | 'jar', nullable, required
    - `connectHost` string, nullable, required
    - `connectPort` integer, nullable, required
    - `connectTlsInsecure` boolean, required
    - `mtlsEnabled` boolean, nullable, required
    - `checkSslEnabled` boolean, nullable, required
    - `checkHttpsRedirectEnabled` boolean, nullable, required
    - `checkStatusEnabled` boolean, nullable, required
    - `checkSizeEnabled` boolean, nullable, required
    - `checkResponseTimeEnabled` boolean, nullable, required
    - `checkKeywordEnabled` boolean, nullable, required
    - `checkDomainExpiryEnabled` boolean, nullable, required
    - `checkExpectedResponseEnabled` boolean, nullable, required
    - `expectedResponseMatchType` 'contains' | 'equals' | 'json_path_equals', nullable, required
    - `expectedResponseValue` string, nullable, required
    - `expectedResponseJsonPath` string, nullable, required
    - `sslNoticeDays` integer, nullable, required
    - `sslErrorDays` integer, nullable, required
    - `domainExpiryNoticeDays` integer, nullable, required
    - `domainExpiryErrorDays` integer, nullable, required
    - `minPageSize` integer, nullable, required
    - `maxPageSize` integer, nullable, required
    - `heartbeatToken` string, nullable, required: Heartbeat monitors: the token of the ping URL.
    - `heartbeatGracePeriodMinutes` integer, nullable, required
    - `status` 'active' | 'inactive' | 'maintenance', required
    - `escalationDisabled` boolean, required
    - `escalationDisabledReason` string, nullable, required
    - `escalationDisabledAt` string, date-time, nullable, required
    - `managementType` 'managed' | 'self_service', required
    - `flappingSince` string, date-time, nullable, required
    - `notificationPhoneNumber` string, nullable, required
    - `notificationEmail` string, nullable, required
    - `lastCheckedAt` string, date-time, nullable, required
    - `lastHeartbeatAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `inMaintenance` boolean, required
    - `isDown` boolean, required
    - `isRecovering` boolean, required
    - `upSinceAt` string, date-time, nullable, required
    - `customerName` string, required
    - `customerPublicId` string, uuid, required
    - `uptimeDay` string, required: Percent with two decimals, e.g. "99.95".
    - `uptimeMonth` string, required
    - `uptimeYear` string, required
    - `avgResponseDay` number, nullable, required
    - `avgResponseMonth` number, nullable, required
    - `avgResponseYear` number, nullable, required
    - `responseGraph` object, required: Recent response times for a sparkline.
      - `values` number[], required
      - `avg` number, nullable, required
    - `tags` object[], required
      - `id` integer, required
      - `publicId` string, uuid, required
      - `name` string, required
      - `color` string, nullable, required
    - `unmeasuredSince` string, date-time, nullable, required
    - `hasCritical` boolean, required
    - `hasWarning` boolean, required
  - `total` integer, required
  - `page` integer, required
  - `perPage` integer, 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)