See the API's various operations for details on their request parameters and response data.
You can also run this API with a Postman collection.
| Operation | Method | Endpoint |
|---|---|---|
| Accounts | ||
| List available accounts | GET | /accounts-with-categories |
| Cases | ||
| List cases | GET | /cases |
| Create a new case | POST | /cases |
| Get a case | GET | /cases/{caseId} |
| Update contact details | PATCH | /cases/{caseId} |
| List attached files | GET | /cases/{caseId}/attachments |
| Attach a file | POST | /cases/{caseId}/attachments |
| Get the status of an attachment upload | GET | /cases/{caseId}/attachments/status/{uploadId} |
| Get an attached file | GET | /cases/{caseId}/attachments/{attachmentId} |
| List comments | GET | /cases/{caseId}/comments |
| Comment a case | POST | /cases/{caseId}/comments |
| Close a case | POST | /cases/{caseId}/request-case-closure |
| Categories | ||
| Get a case category | GET | /categories/{categoryId} |