curl --request GET \
--url 'https://api.nsr.stateset.com/api/v1/flywheel/candidates' \
--header 'X-API-Key: YOUR_API_KEY'
{
"candidates": [
{
"artifact_type": "Rule",
"content": null,
"created_at": "2026-07-24T12:00:00Z",
"evidence_events": [],
"id": "string",
"org_id": "string",
"reviewed_at": "2026-07-24T12:00:00Z",
"reviewed_by": "string",
"status": "Pending"
}
],
"total": 1
}
Flywheel candidates handler
Required scope: read
GET
/
api
/
v1
/
flywheel
/
candidates
curl --request GET \
--url 'https://api.nsr.stateset.com/api/v1/flywheel/candidates' \
--header 'X-API-Key: YOUR_API_KEY'
{
"candidates": [
{
"artifact_type": "Rule",
"content": null,
"created_at": "2026-07-24T12:00:00Z",
"evidence_events": [],
"id": "string",
"org_id": "string",
"reviewed_at": "2026-07-24T12:00:00Z",
"reviewed_by": "string",
"status": "Pending"
}
],
"total": 1
}
Required scope:
read
Query parameters
string
Filter by candidate status: pending, approved, rejected, auto_promoted
Response
FlywheelCandidatesResponse
PromotionCandidate[]
required
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 --request GET \
--url 'https://api.nsr.stateset.com/api/v1/flywheel/candidates' \
--header 'X-API-Key: YOUR_API_KEY'
{
"candidates": [
{
"artifact_type": "Rule",
"content": null,
"created_at": "2026-07-24T12:00:00Z",
"evidence_events": [],
"id": "string",
"org_id": "string",
"reviewed_at": "2026-07-24T12:00:00Z",
"reviewed_by": "string",
"status": "Pending"
}
],
"total": 1
}