Appearance
apphost.site.list ​
Paginated list of an organization's hosted sites with their serving URLs
List the organization's HostedSites, newest first.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-apphost |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Org whose sites to list; rows outside it are never returned |
limit | integer | No | 50 | Page size (default 50, capped at 200) |
offset | integer | No | 0 | Rows to skip from the newest site (default 0) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
items | json | No | — | Site rows — site_uuid, slug, mode, url, active_release_uuid, timestamps |
count | integer | No | — | — |
total | integer | No | — | — |
limit | integer | No | — | — |
offset | integer | No | — | — |
error | string | No | — | — |
error_type | string | No | — | Error-as-field envelope populated when query() raises. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
listed | SUCCESS | Hosted sites returned | count |
failed | FAILURE | Apphost workflow failed | failure_reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "apphost.site.list",
"initial_data": {
"organization_uuid": "value"
}
}