Description
Retrieve a list of records attached to a case.
Request
HTTP Method: GET
| Parameter | Description |
|---|---|
| case_id | The ID of the case. |
| per_page | Optional Set the number of results returned per page. Defaults to 20. |
| page | Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. |
curl -X GET \
https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/records \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Response
A successful request will return a JSON object with the records.
Field description
| Parameter | Description |
|---|---|
| case_id | The ID of the case. |
| records | An array of records attached to the case. See the table below for more details. |
| Records parameter | Description |
|---|---|
| id | The record ID. |
| record_type | The record type. Includes id and name. |
| records | An array of record fields. Includes the field id, name, and value. |
| created_at | The timestamp the record was created. |
Sample response
{
"case_id": 42,
"records": [
{
"id": 187,
"record_type": { "id": 1, "name": "Alert" },
"records": [
{
"id": 1871,
"name": "Story name",
"value": "Cases API"
}
],
"created_at": "2023-12-18T22:29:22Z"
}
],
"meta": {
"current_page": "https://<<META.tenant.domain>>/api/v2/cases/42/records?per_page=20&page=1",
"previous_page": null,
"next_page": null,
"per_page": 20,
"pages": 1,
"count": 1
}
}