Skip to main content

Conventions

Request Headers​

Use these headers for API requests:

  • Authorization: Bearer <access_token>
  • Content-Type: application/json
  • Accept: application/json

Response Format​

Responses are JSON.

Date and Time​

Use ISO 8601 date/time values in UTC where date-time fields are used.

Path and Query Parameters​

  • Path parameters identify specific entities (for example {caseId}, {taskId}).
  • Query parameters are used for filtering and listing controls where supported.

HTTP Methods​

  • GET for read operations.
  • POST for create or action operations.
  • PUT for full updates.
  • PATCH for partial updates.
  • DELETE for delete operations.

Idempotency​

  • GET, PUT, and DELETE should be treated as idempotent.
  • Webhook consumers should process events idempotently using event identifiers.