List all rules

List rules with pagination. Required scope: read

GET /api/v1/rules

cURL

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

200

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

List rules with pagination.

Required scope: read

Query parameters

limit · integer

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

offset · integer

Number of items to skip (default: 0)

cursor · string

Cursor for cursor-based pagination (alternative to offset)

sort · string

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

Response

PaginatedRuleListResponse

items · any[] · required

The items in this page

pagination · PaginationMeta · required

Show PaginationMeta

has_more · boolean · required

Whether there are more items after this page

limit · integer · required

Current page limit

next_cursor · string

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

offset · integer · required

Current offset

prev_cursor · string

Cursor for the previous page

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

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

200

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