Flywheel candidates handler

Required scope: read

GET /api/v1/flywheel/candidates

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/flywheel/candidates' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "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
}

Required scope: read

Query parameters

status · string

Filter by candidate status: pending, approved, rejected, auto_promoted

Response

FlywheelCandidatesResponse

candidates · PromotionCandidate[] · required

Show PromotionCandidate

artifact_type · ArtifactType · required

content · any · required

created_at · string (date-time) · required

evidence_events · string[] · required

id · string · required

org_id · string

reviewed_at · string (date-time)

reviewed_by · string

status · PromotionStatus · required

total · 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

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/flywheel/candidates' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "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
}