get https://api.talkdeskapp.com/cm/core/va/cases/
by ID
Scope
cases-public:read
Body Response - Schema
200 (case data)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | case ID | yes |
| title | string | case subject | yes |
| description | string | case description | yes |
| requester_id | string | requester ID | no |
| requester_name | string | requester name | no |
| requester_email | string | requester email | no |
| requester_phone | string | requester phone | no |
| group_id | string | group name | no |
| agent_id | string | agent ID | no |
| agent_name | string | agent name | no |
| status | string | case status | yes |
| type | string | case type | yes |
| priority | string | case priority | yes |
| custom_fields | object | case custom field response data | yes |
| notes | array[object] | The notes of the array. "notes" subdivides into: 1 - "id" (string) - note ID. 2 - "note_title" (string) 3 - "note_body" (string) 4 - "public" (boolean) - is true if any notes are public, false otherwise. Defaults to true. | no |
400 (bad request), 401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden), 404 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Case API has been in GA since October 2023.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.