> ## 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.

# Flywheel candidates handler

> **Required scope:** read

**Required scope:** `read`

### Query parameters

<ParamField query="status" type="string">
  Filter by candidate status: pending, approved, rejected, auto\_promoted
</ParamField>

### Response

`FlywheelCandidatesResponse`

<ResponseField name="candidates" type="PromotionCandidate[]" required>
  <Expandable title="PromotionCandidate">
    <ResponseField name="artifact_type" type="ArtifactType" required />

    <ResponseField name="content" type="any" required />

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

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

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

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

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

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

    <ResponseField name="status" type="PromotionStatus" required />
  </Expandable>
</ResponseField>

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

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | Promotion candidates                               |
| `400` | Invalid status filter                              |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.nsr.stateset.com/api/v1/flywheel/candidates' \
    --header 'X-API-Key: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "candidates": [
      {
        "artifact_type": "Rule",
        "content": null,
        "created_at": "2026-08-31T14:22:05Z",
        "evidence_events": [],
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "reviewed_at": "2026-08-31T14:22:05Z",
        "reviewed_by": "string",
        "status": "Pending"
      }
    ],
    "total": 102
  }
  ```
</ResponseExample>