Description
Retrieve a single note for a case.
Request
HTTP Method: GET
| Parameter | Description |
|---|---|
| case_id | The ID of the case. |
| note_id | The ID of the note. |
curl -X GET \
https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/notes/<<note_id>> \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Response
A successful request will return a JSON object of the note.
Field description
| Parameter | Description |
|---|---|
| case_id | The ID of the case. |
| id | The ID of the note record attached to the case. |
| title | The title of the note. |
| content | The content of the note. |
| color | The color of the note - options: white, gold, magenta, green, blue. |
| author | Details of the author of the note. |
| created_at | ISO 8601 Timestamp representing creation date and time. |
| updated_at | ISO 8601 Timestamp representing last updated date and time. |
| Author parameter | Description |
|---|---|
| user_id | The user ID. |
| first_name | The user's first name. |
| last_name | The user's last name. |
| The user's email address. | |
| avatar_url | The user's avatar url. |
| is_service_account | Whether this user is a service account (true/false). |
Sample response
{
"case_id": 42,
"id": 7508,
"title": "Note title",
"content": "This is a case note.",
"color": "white",
"created_at": "2025-01-07T11:42:58Z",
"created_at": "2025-01-07T11:42:58Z",
"user": {
"user_id": 1,
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@tines.io",
"avatar_url": "example.com/avatar",
"is_service_account": false
}
}