Skip to Content
Uptimeify Docs
Whitelabel

List Domains

Returns all custom app domains for the organization. Only domains with role app are returned. Requires admin role.

GET /api/organization/whitelabel/domains

Query Parameters

ParameterTypeDefaultDescription
envelopestringnoneitems: answer as { items, total, page, perPage }. Becomes the default on 2027-01-18.

Example (cURL)

curl -X GET "$BASE_URL/api/organization/whitelabel/domains?envelope=items" \
  -H "Cookie: $SESSION_COOKIE" \
  -H "Accept: application/json"

Response

{
  "items": [
    {
      "id": 1,
      "hostname": "app.deinkunde.com",
      "status": "active",
      "role": "app",
      "isPrimary": true,
      "verificationToken": "abc123-def456",
      "verifiedAt": "2026-01-15T10:00:00.000Z",
      "lastVerificationError": null,
      "lastVerificationErrorAt": null,
      "createdAt": "2026-01-14T08:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "perPage": 1
}

List form: with envelope=items the list arrives as { items, total, page, perPage }. Without it the endpoint still answers the current form ({ "domains": [...] }), which is deprecated; { items, ... } becomes the default on 2027-01-18.

Common errors

  • 401 Unauthorized when not authenticated
  • 403 Forbidden when not an admin

On this page