---
title: "App Domains"
description: "REST endpoints for app domains. Bearer-auth required."
section: "API"
group: "REST"
order: 16
---

## GET /api/app-domains

List custom domains across the caller's accessible apps.

**Query parameters**

- `limit` (optional): Page size (1–100, default 100).
- `after` (optional): Keyset cursor — return the page after this row (next page).
- `before` (optional): Keyset cursor — return the page before this row (prev page).
- `ids` (optional): Comma-separated list of IDs. Narrows results to these IDs within the caller's accessible scope (does not bypass access checks).
- `filter` (optional): Nested filter expression (`<Entity>Filter`): AND/OR/NOT + per-field comparison operators + relation traversal. JSON-encoded on the query string.
- `orderBy` (optional): Multi-key sort (`<Entity>OrderBy[]`): array of `{ field: direction }` applied in order. Directions: asc/desc plus the four explicit nulls variants. JSON-encoded on the query string.
- `app_id` (optional): Filter to a specific app.
- `status` (optional): Filter by lifecycle status.
- `created_by` (optional): Shorthand: filter where `createdBy` equals this value.

**Response**

```json
{
  "data": [
    {
      "id": "<...>",
      "appId": "<...>",
      "hostname": "<...>",
      "status": "<...>",
      "lastError": "<...>",
      "createdBy": "<...>",
      "createdAt": "<...>",
      "updatedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}
```

## GET /api/app-domains/{id}

Get a single app domain row by ID.

**Path parameters**

- `id` (required): Domain row to retrieve.

**Response**

```json
{
  "id": "string",
  "appId": "string",
  "hostname": "string",
  "status": "pending | active | failed",
  "lastError": "string",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
```
