API referenceApprovals

GET /api/v1/rules

The content rules that apply to this API key or connected app: organization-wide rules, its own rules and account rules. Read only; a person edits them in the dashboard. A write that matches a block rule is refused with 422 rule_violation (error.rules lists the hits); a review rule holds it for approval

GET
/api/v1/rules

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Response Body

{rules}

application/json
  1. response
rules?array<>
Example Request
curl -X GET 'https://example.com/api/v1/rules'
Example Response
{  "rules": [    {      "id": "string",      "name": "string",      "scope": "organization",      "scopeId": "string",      "kind": "banned_terms",      "config": {},      "action": "review",      "enabled": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

GET /api/v1/actions GET

Agent actions queued for approval in this organization, newest first

GET /api/v1/actions/{id} GET

One queued action: its status, the exact call (as edited by the reviewer), and the result or error once it ran