StateSet API Docs

List rules with pagination. Required scope: read

Query parameters

integer

Maximum number of items to return (1-1000, default: 50)

integer

Number of items to skip (default: 0)

string

Cursor for cursor-based pagination (alternative to offset)

string

Sort field with optional direction prefix (- for descending) Examples: ‘created_at’, ‘-name’, ‘confidence’

Response

PaginatedRuleListResponse

any[]

required

The items in this page

PaginationMeta

required

Show PaginationMeta

boolean

required

Whether there are more items after this page

integer

required

Current page limit

string

Cursor for the next page (if using cursor-based pagination)

integer

required

Current offset

string

Cursor for the previous page

integer

Total number of items (if available)

Status codes

Code	Meaning
`200`	Paginated list of the org’s rules
`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/rules' \
  --header 'X-API-Key: YOUR_API_KEY'

{
  "items": [],
  "pagination": {
    "has_more": true,
    "limit": 1,
    "next_cursor": "string",
    "offset": 1,
    "prev_cursor": "string",
    "total": 1
  }
}

​Query parameters

​Response

​Status codes

Query parameters

Response

Status codes