List

Description

Retrieve a list of blocks for a case.

Request

HTTP Method: GET

Parameter Description
case_id The ID of the case.
block_type Optional Filter blocks by type. Options: note, file.
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>>/blocks \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object with the blocks.

Field description

Parameter Description
blocks An array of block objects attached to a case.
Block Parameter Description
id The ID of the block record attached to the case.
title The title of the block.
block_type The type of the block - options: note, file.
position The position of the block in the case.
elements An array of elements contained within the block.
created_at ISO 8601 Timestamp representing creation date and time.
updated_at ISO 8601 Timestamp representing last updated date and time.

Common Element Parameters

Parameter Description
element_id The unique ID of this element within the current block.
id The original/source ID of the element.
element_type The type of the element - options: note, file.
author Details of the author of the element.
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.
email The user's email address.
avatar_url The user's avatar url.
is_service_account Whether this user is a service account (true/false).

Note Element Parameters

Parameter Description
content The content of the note.
note_type The type of note - currently only "text" is supported.
color The color of the note - options: white, gold, magenta, green, blue.

File Element Parameters

Parameter Description
file Object containing file information (filename and url).

Sample response

{
  "blocks": [
    {
      "id": 123,
      "title": "Note Block",
      "block_type": "note",
      "position": 0,
      "elements": [
        {
          "element_id": 456,
          "id": 123,
          "element_type": "note",
          "content": "This is a note element",
          "note_type": "text",
          "color": "white",
          "author": {
            "user_id": "1",
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane@tines.io",
            "avatar_url": "example.com/avatar",
            "is_service_account": false
          },
          "created_at": "2025-01-07T11:42:58Z",
          "updated_at": "2025-01-07T11:42:58Z"
        }
      ],
      "created_at": "2025-01-07T11:42:58Z",
      "updated_at": "2025-01-07T11:42:58Z"
    },
    {
      "id": 124,
      "title": "File Block",
      "block_type": "file",
      "position": 1,
      "elements": [
        {
          "id": 457,
          "element_type": "file",
          "file": {
            "filename": "example.txt",
            "url": "https://example.com/files/example.txt"
          },
          "author": {
            "user_id": "1",
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane@tines.io",
            "avatar_url": "example.com/avatar",
            "is_service_account": false
          },
          "created_at": "2025-01-07T11:43:58Z",
          "updated_at": "2025-01-07T11:43:58Z"
        }
      ],
      "created_at": "2025-01-07T11:43:58Z",
      "updated_at": "2025-01-07T11:43:58Z"
    }
  ]
}
Was this helpful?