Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Policies API

Fetch your organization’s configured policies programmatically.

Endpoint

GET /api/v1/policies/

Authentication: X-API-KEY header. See API Keys & Authentication.

Response

{
  "policies": [
    {
      "id": "policy-id-1",
      "name": "Violence",
      "parentId": null,
      "policyText": "Do not post graphic violence.",
      "enforcementGuidelines": null,
      "policyType": "VIOLENCE",
      "semanticVersion": 1,
      "userStrikeCount": 1,
      "applyUserStrikeCountConfigToChildren": false,
      "penalty": "NONE"
    }
  ]
}

Response fields

FieldTypeDescription
policiesArrayAll policies for your organization
policies[].idStringCoop’s unique, immutable ID for this policy
policies[].nameStringThe display name you assigned to this policy
policies[].parentIdString or nullParent policy ID, or null for a top-level policy
policies[].policyTextString or nullPolicy text
policies[].enforcementGuidelinesString or nullGuidance for enforcement
policies[].policyTypeString or nullPolicy category, such as VIOLENCE
policies[].semanticVersionNumberPolicy semantic version
policies[].userStrikeCountNumberConfigured user strike count
policies[].applyUserStrikeCountConfigToChildrenBooleanWhether child policies inherit the strike configuration
policies[].penaltyStringNONE, LOW, MEDIUM, HIGH, or SEVERE

Notes

  • Use parentId to reconstruct the full policy tree. A null parentId indicates a top-level policy; a non-null parentId links a sub-policy to its parent.

  • Build integrations against policy id values, not name values. Names can be changed in the dashboard; IDs are immutable.

  • For background on how policies are structured and used, see Basic Concepts and Administration.