Get one rule

The rule

GET /api/v1/rules/{id}

cURL

curl --request GET \
  --url 'https://response.stateset.com/api/v1/rules/{id}' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "object": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "type": "standard",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "activated": true,
  "conditions": null,
  "actions": null,
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Path parameters

id · string (uuid) · required

The rule id.

Response

Rule

object · string

id · string

name · string,null

type · string,null

description · string,null

activated · boolean

conditions · any

actions · any

agent_id · string,null

Status codes

Code	Meaning
200	The rule
401	Missing, invalid, or expired API key.
403	The key lacks a required scope.
404	Not found, or not in the organization that owns the key.
429	Rate limit exceeded.

Access

Required scope	agents:read
Rate limit	120 requests per minute

cURL

curl --request GET \
  --url 'https://response.stateset.com/api/v1/rules/{id}' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "object": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "type": "standard",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "activated": true,
  "conditions": null,
  "actions": null,
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}