1. API
  2. Cases
  3. Tasks

Tasks: List

Last updated Open markdown version

Description

Retrieve a list of tasks for a specific case.

See the Get Task API to learn more about case tasks.

Request

HTTP Method: GET

Query Parameter Description
case_id The ID of the case to retrieve tasks for.
per_page Optional Set the number of results returned per page. Defaults to 20, maximum is 50.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. 
curl -X GET \
  'https://<tenant-domain>/api/v2/cases/<<case_id>>/tasks?page=1&per_page=20' \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object containing an array of tasks for the specified case.

Field description

Parameter Description
tasks An array of task objects associated with the case.
meta Pagination metadata (see below).

Task object fields

Parameter Description
id The task ID.
description The task description.
completed Boolean indicating whether the task is completed.
assignees An array of users assigned to the task.
created_at ISO 8601 Timestamp representing the date and time the task was created at.
updated_at ISO 8601 Timestamp representing the date and time the task was updated at.

Assignee object fields

Parameter Description
id The user ID.
email The user email.
first_name The user's first name.
last_name The user's last name.

Sample response

{
  "tasks": [
    {
      "id": 1,
      "description": "Review security logs",
      "completed": false,
      "assignees": [
        {
          "id": "123",
          "email": "user1@example.com",
          "first_name": "John",
          "last_name": "Doe"
        },
        {
          "id": "456",
          "email": "user2@example.com",
          "first_name": "Jane",
          "last_name": "Smith"
        }
      ],
      "created_at": "2024-03-25T15:40:39Z",
      "updated_at": "2024-03-25T15:40:39Z"
    },
    {
      "id": 2,
      "description": "Contact affected users",
      "completed": true,
      "assignees": [
        {
          "id": "789",
          "email": "user3@example.com",
          "first_name": "Bob",
          "last_name": "Johnson"
        }
      ],
      "created_at": "2024-03-25T15:30:20Z",
      "updated_at": "2024-03-25T16:15:45Z"
    }
  ],
  "meta": {
    "current_page": "https://<tenant-domain>/api/v2/cases/1/tasks?per_page=20&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 2
  }
}
Was this helpful?