data.spad.site.list ​
List SpadSite rows for an organization (UUID-only; internal ids stripped)
List SpadSite rows for an organization with optional filters.
Inputs:
- organization_uuid: Organization UUID (required; resolved from request context)
- name_contains: Case-insensitive substring filter on name/slug (optional)
- cloud_connection_uuid: Restrict to sites on a cloud connection (optional)
- limit: Page size — clamped to the engine-wide hard cap (default 50)
- offset: Pagination offset (default 0)
Outputs (terminal state_data):
- items: list of site public dicts (UUID-only, no internal ids)
- count: number of items returned
- total: total rows matching the filter (across all pages)
- limit: effective limit after clamping
- offset: offset used
- error: str | None (set when query() raised; only present on failure)
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-spad |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
name_contains | string | No | — | Case-insensitive substring on name/slug |
cloud_connection_uuid | uuid | No | — | Restrict to sites on a cloud connection |
limit | integer | No | 50 | Page size — hard-capped by the engine |
offset | integer | No | 0 | Pagination offset |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
items | list | Yes | — | — |
count | integer | Yes | — | — |
total | integer | Yes | — | — |
limit | integer | Yes | — | — |
offset | integer | Yes | — | — |
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 | — | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.spad.site.list",
"initial_data": {
"organization_uuid": "value"
}
}