API Reference
Learn about the Coop API, including the REST API endpoints your platform uses to integrate with Coop.
All endpoints require an API key passed as an HTTP header on every request:
X-API-KEY: <<apiKey>>
Content-Type: application/json
You can find or rotate your API key under Settings → API Keys in the Coop UI. For details on verifying the signatures Coop adds to outgoing webhook requests, see API Keys & Authentication.
| Endpoint | Description |
|---|---|
POST /api/v1/items/async/ | Items: send content for rule evaluation |
POST /api/v1/report | Report: submit a user report |
POST /api/v1/report/appeal | Appeal: submit a user appeal |
GET /api/v1/policies/ | Policies: fetch your configured policies |
GET /api/v1/user_scores | User Scores: fetch a user’s moderation score |
POST /api/v1/gdpr/delete | GDPR Deletion: delete a user’s data |
See also:
- Handling Actions: information about receiving action webhooks from Coop
- Partial Items API: support Coop fetching Items and their attributes on demand
- Errors: details of error responses from Coop