Skip to content

API Scenarios ​

This page organizes common API integration paths by business goal. If you already know which endpoint to call, go back to API Overview for the API index.

Scenario list ​

Read scenarios ​

Write scenarios ​

Management scenarios ​

These three need a personal API key. Organization keys cannot call them.

Reading tips ​

  • Unsure about authentication: read Authentication
  • Need field details, schema, or full examples: jump from scenario pages to corresponding API pages
  • Want every endpoint and the permission it needs: see the API list
  • Need code generation or tool import: use https://open.cli.im/openapi.json