Cases
A case is a unit of work oHallo tracks for a customer, for example an order issue, a return, or a quote in progress. The Cases API is read-only: use it to sync the case record into your own systems and reporting. Creating and working cases happens in the dashboard.
Required scope: cases:read
List cases
Section titled “List cases”Retrieve cases for the account, newest first.
curl "https://api.ohallo.eu/api/cases?status=open&workspaceId=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer sf_live_v1_a3Bx9kLmP2qR7wYz4nDfGhJkQpStUvWx"Query parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | No | Restrict to one workspace |
status | string | No | open, resolved, or closed |
contactId | string | No | Cases for one contact |
accountId | string | No | Cases for one account |
Response: an array of cases.
[ { "id": "11223344-5566-4788-99aa-bbccddeeff00", "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "contactId": "44556677-8899-4a1b-8c2d-3e4f5a6b7c8d", "accountId": "12345678-abcd-4f01-a345-678901234567", "caseType": "order_issue", "status": "open", "outcome": null, "businessValue": "1250.00", "businessValueCurrency": "EUR", "contactName": "Jane Andersen", "accountName": "Nordic Parts ApS", "workflowId": null, "parentCaseId": null, "openedAt": "2026-05-10T09:00:00.000Z", "resolvedAt": null, "closedAt": null, "createdAt": "2026-05-10T09:00:00.000Z", "updatedAt": "2026-05-12T14:30:00.000Z" }]Get a case
Section titled “Get a case”Retrieve a single case by id.
curl "https://api.ohallo.eu/api/cases/11223344-5566-4788-99aa-bbccddeeff00" \ -H "Authorization: Bearer sf_live_v1_a3Bx9kLmP2qR7wYz4nDfGhJkQpStUvWx"Response: the case object (the same shape as a list item). Returns 404 if the case does not exist.
Get a case’s events
Section titled “Get a case’s events”Retrieve the case work record: the ordered events that show how the case progressed.
curl "https://api.ohallo.eu/api/cases/11223344-5566-4788-99aa-bbccddeeff00/events" \ -H "Authorization: Bearer sf_live_v1_a3Bx9kLmP2qR7wYz4nDfGhJkQpStUvWx"Response:
{ "events": [ { "eventType": "case_opened", "occurredAt": "2026-05-10T09:00:00.000Z" }, { "eventType": "artifact_updated", "occurredAt": "2026-05-11T11:20:00.000Z" } ]}List case types
Section titled “List case types”Retrieve the case types configured for the account. Use these to label cases from the list above.
curl "https://api.ohallo.eu/api/case-types" \ -H "Authorization: Bearer sf_live_v1_a3Bx9kLmP2qR7wYz4nDfGhJkQpStUvWx"Response:
{ "caseTypes": [ { "id": "order_issue", "label": "Order issue" }, { "id": "return", "label": "Return" } ]}