> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List onboarding runs

> Onboarding runs for the brand.

### Path parameters

<ParamField path="brand_id" type="string (uuid)" required />

### Query parameters

<ParamField query="limit" type="integer">
  Max items (capped at 1000).
</ParamField>

<ParamField query="offset" type="integer" />

<ParamField query="status" type="string">
  Filter by status.
</ParamField>

### Response

`object[]` — each element:

<ResponseField name="id" type="string (uuid)" required />

<ResponseField name="brand_id" type="string (uuid)" required />

<ResponseField name="status" type="string" required />

<ResponseField name="checks" type="object" required />

<ResponseField name="notes" type="string" />

<ResponseField name="validation" type="object">
  Validation report

  <Expandable title="validation">
    <ResponseField name="valid" type="boolean" required />

    <ResponseField name="errors" type="string[]" required />

    <ResponseField name="warnings" type="string[]" required />

    <ResponseField name="checks" type="object[]" required>
      <Expandable title="checks">
        <ResponseField name="code" type="string" required />

        <ResponseField name="ok" type="boolean" required />

        <ResponseField name="message" type="string" required />
      </Expandable>
    </ResponseField>

    <ResponseField name="readiness" type="object">
      <Expandable title="readiness">
        <ResponseField name="activation_ready" type="boolean" required />

        <ResponseField name="self_service_ready" type="boolean" required />

        <ResponseField name="summary" type="string" required />

        <ResponseField name="steps" type="object[]" required />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="guide" type="object">
  <Expandable title="guide">
    <ResponseField name="activation_ready" type="boolean" required />

    <ResponseField name="self_service_ready" type="boolean" required />

    <ResponseField name="publish_ready" type="boolean" required />

    <ResponseField name="test_run_passed" type="boolean" required />

    <ResponseField name="progress_percent" type="integer" required />

    <ResponseField name="next_step_id" type="string" />

    <ResponseField name="summary" type="string" required />

    <ResponseField name="steps" type="object[]" required>
      <Expandable title="steps">
        <ResponseField name="id" type="string" required />

        <ResponseField name="title" type="string" required />

        <ResponseField name="status" type="string" required />

        <ResponseField name="required" type="boolean" required />

        <ResponseField name="summary" type="string" required />

        <ResponseField name="details" type="string[]" required />

        <ResponseField name="action_label" type="string" />

        <ResponseField name="suggested_tab" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="value_plan" type="object" required>
      <Expandable title="value_plan">
        <ResponseField name="summary" type="string" required />

        <ResponseField name="recommended_routing_mode" type="string" required />

        <ResponseField name="recommended_routing_reason" type="string" required />

        <ResponseField name="estimated_minutes_to_value" type="integer" required />

        <ResponseField name="initial_channels" type="string[]" required />

        <ResponseField name="automation_jobs" type="string[]" required />

        <ResponseField name="monetizable_outcomes" type="string[]" required />

        <ResponseField name="quickstart_actions" type="object[]" required />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="created_at" type="string (date-time)" required />

<ResponseField name="updated_at" type="string (date-time)" required />

### Status codes

| Code  | Meaning                        |
| ----- | ------------------------------ |
| `200` | Onboarding runs for the brand. |
| `400` | Validation error               |
| `401` | Unauthorized                   |
| `404` | Not found                      |
| `429` | Rate limited                   |
| `500` | Internal error                 |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/onboarding' \
    --header "x-api-key: $STATESET_TEMPORAL_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "checks": {},
      "notes": "Two-person tent, green — replacement for damaged pole set.",
      "validation": {
        "valid": true,
        "errors": [],
        "warnings": [],
        "checks": [],
        "readiness": {
          "activation_ready": null,
          "self_service_ready": null,
          "summary": null,
          "steps": null
        }
      },
      "guide": {
        "activation_ready": true,
        "self_service_ready": true,
        "publish_ready": true,
        "test_run_passed": true,
        "progress_percent": 8,
        "next_step_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "summary": "Two-person tent, green — replacement for damaged pole set.",
        "steps": [],
        "value_plan": {
          "summary": null,
          "recommended_routing_mode": null,
          "recommended_routing_reason": null,
          "estimated_minutes_to_value": null,
          "initial_channels": null,
          "automation_jobs": null,
          "monetizable_outcomes": null,
          "quickstart_actions": null
        }
      },
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ]
  ```
</ResponseExample>