Get

⚠️ Note
This API endpoint has been deprecated, please update to the latest version.

Description

Retrieve a single record attached to a case.

Request

HTTP Method: GET

Parameter Description
case_id The ID of the case.
record_id The ID of the record attached to the case. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/cases/<<case_id>>/records/<<record_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object of the record.

Field description

Parameter Description
case_id The case ID.
record The record 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,
  "record": {
    "id": 187,
    "record_type": { "id": 1, "name": "Alert" },
    "records": [
      {
        "id": 1871,
        "name": "Story name",
        "value": "Cases API"
      }
    ],
    "created_at": "2023-12-18T22:29:22Z"
  }
}
Was this helpful?