Skip to main content
GET
/
{team_id}
/
comments
Retrieve all comments for a team
curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/comments \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.superthread.com/v1/{team_id}/comments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superthread.com/v1/{team_id}/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superthread.com/v1/{team_id}/comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superthread.com/v1/{team_id}/comments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.superthread.com/v1/{team_id}/comments")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.superthread.com/v1/{team_id}/comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "cursor": "dmsjqh9d8w1hdjosjaasda",
  "count": 14,
  "comments": [
    {
      "id": "42",
      "content": "Good point!",
      "is_internal": true,
      "schema": 1,
      "page_id": "431",
      "card_id": "433",
      "user_id": "u-dsu0j19",
      "user": {
        "user_id": "uDsu0j19",
        "type": "user",
        "source": {
          "type": "oauth",
          "client_id": "oczapier",
          "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
          "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
          "email_addr": "somebody@example.com",
          "email_verified": false,
          "on_behalf_of": "<string>"
        }
      },
      "user_updated": {
        "user_id": "uDsu0j19",
        "type": "user",
        "source": {
          "type": "oauth",
          "client_id": "oczapier",
          "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
          "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
          "email_addr": "somebody@example.com",
          "email_verified": false,
          "on_behalf_of": "<string>"
        }
      },
      "team_id": "u-dsu0j19",
      "time_created": 1608742037016,
      "time_updated": 1608742037016,
      "reactions": [
        {
          "id": "sweat_smile",
          "unicode": "<string>",
          "members": [
            {
              "user_id": "<string>",
              "time_created": 1608742037016,
              "variation": "<string>"
            }
          ]
        }
      ],
      "health_update_metadata": {
        "previous": "on_track",
        "new": "on_track",
        "time": 1608742037016
      },
      "context": "attach context to a comment",
      "participants": [
        "<string>"
      ],
      "children": {
        "cursor": "dmsjqh9d8w1hdjosjaasda",
        "count": 14,
        "child_comments": [
          {
            "id": "42",
            "content": "Good point!",
            "is_internal": true,
            "schema": 1,
            "page_id": "431",
            "card_id": "433",
            "user_id": "u-dsu0j19",
            "user": {
              "user_id": "uDsu0j19",
              "type": "user",
              "source": {
                "type": "oauth",
                "client_id": "oczapier",
                "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
                "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
                "email_addr": "somebody@example.com",
                "email_verified": false,
                "on_behalf_of": "<string>"
              }
            },
            "user_updated": {
              "user_id": "uDsu0j19",
              "type": "user",
              "source": {
                "type": "oauth",
                "client_id": "oczapier",
                "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
                "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
                "email_addr": "somebody@example.com",
                "email_verified": false,
                "on_behalf_of": "<string>"
              }
            },
            "team_id": "u-dsu0j19",
            "time_created": 1608742037016,
            "time_updated": 1608742037016,
            "reactions": [
              {
                "id": "sweat_smile",
                "unicode": "<string>",
                "members": [
                  {
                    "user_id": "<string>",
                    "time_created": 1608742037016,
                    "variation": "<string>"
                  }
                ]
              }
            ],
            "health_update_metadata": {
              "previous": "on_track",
              "new": "on_track",
              "time": 1608742037016
            },
            "parent_id": "1"
          }
        ]
      }
    }
  ]
}
{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Query Parameters

page_id
string

Page ID is a numerical string that identifies a Page.

card_id
string

Card ID is a numerical string that identifies a card.

filter
enum<string>

Optional filter on comments. Defaults to not filtering if not specified

Available options:
resolved,
open,
orphaned

Response

array of comments

cursor
string
required
Example:

"dmsjqh9d8w1hdjosjaasda"

count
integer
required
Example:

14

comments
object[]