Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-spad
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID
name_containsstringNo—Case-insensitive substring on name/slug
cloud_connection_uuiduuidNo—Restrict to sites on a cloud connection
limitintegerNo50Page size — hard-capped by the engine
offsetintegerNo0Pagination offset

Output Schema ​

FieldTypeRequiredDefaultDescription
itemslistYes——
countintegerYes——
totalintegerYes——
limitintegerYes——
offsetintegerYes——
errorstringNo——
error_typestringNo—Error-as-field envelope populated when query() raises.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.spad.site.list",
  "initial_data": {
    "organization_uuid": "value"
  }
}