Get

Description

Retrieve a single case.

Request

HTTP Method: GET

Parameter Description
case_id The ID of the case to retrieve. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/cases/<<case_id>> \
  -H 'content-type: application/json' \
  -H 'x-user-token: <api-token>'

Response

A successful request will return a JSON object representing the specified case.

Field description

Parameter Description
case_id The case ID.
team The team the case is within - ID & name.
name The case name.
description The case description.
status The case status - open or closed.
author The case author.
priority The case priority - high, medium or low.
assignees An array of users assigned to the case.
tags An array of tags associated with the case.
records An array of records associated with the case.
team_case_actions An array of team case actions taken within the case.
opened_at ISO 8601 Timestamp representing the date and time the case was opened at.
resolved_at ISO 8601 Timestamp representing the date and time the case was resolved at.
metadata Case related metadata represented as key-value pairs.
team_case_buttons An array of team case buttons for downstream actions associated with the case.
linked_cases An array of cases linked to this case (IDs only).

Sample response

{
  "case_id": 42,
  "name": "Suspicious login detected",
  "description": "This is a high priority case created via the API",
  "status": "OPEN",
  "priority": "HIGH",
  "author": {
    "id": 1,
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@tines.io"
  },
  "assignees": [
    {
      "id": 1,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@tines.io"
    }
  ],
  "tags": [
    {
      "id": 4,
      "name": "login"
    }
  ],
  "team_case_actions": [
    {
      "id": 7508,
      "action": "CREATED",
      "value": "42",
      "user": {}
    }
  ],
  "team": {
    "id":2,
    "name": "Team 1"
  },
  "records": [
    {
      "id": 187,
      "results": [
        {
          "id": 1871,
          "name": "Story name",
          "value": "Cases API"
        },
      ]
    }
  ],
  "team_case_buttons": [
    {
      "id": 8,
      "button_type": "webhook",
      "url": "http://tenant.tines.com/webhook/e840b4e8cf60437196d9a4bcb85d2de0/61441bc05fddfa4c09924b23fcf72b91",
      "label": "Isolate host"
    },
        {
      "id": 9,
      "button_type": "page",
      "url": "https://tenant.tines.com/pages/55e94b9b4e26175051c0287f4259363f/",
      "label": "Isolate host and submit reason"
    }
  ]
},
Was this helpful?