Get a thread and its comments

v1.0.0

Get a thread and page through its comments, oldest first, starting with the comment that opened it.

Comments are paginated: at most 250 are returned per request. Keep paginating for as long as a next_cursor is returned.

Supply created_after to return only the comments created after a timestamp, which is useful when polling a thread for new replies. The comment that opened the thread is returned only when it also satisfies the filter.

To view threads on records, you will need the object_configuration:read and record_permission:read scopes.

To view threads on list entries, you will need the list_configuration:read and list_entry:read scopes.

Required scopes: comment:read.

Input

{
  "type": "object",
  "properties": {
    "created_after": {
      "type": [
        "string",
        "null"
      ],
      "description": "Only return comments created after this timestamp."
    },
    "cursor": {
      "type": "string",
      "description": "A cursor for pagination. Use the `next_cursor` from the previous response to get the next page of comments."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of comments to return. Defaults to `250`, which is also the maximum."
    },
    "thread_id": {
      "type": "string",
      "format": "uuid",
      "description": "A UUID which identifies the thread."
    }
  },
  "required": [
    "thread_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "comments",
        "created_at",
        "id"
      ],
      "properties": {
        "comments": {
          "type": "array",
          "description": "The requested page of comments in the thread, sorted by `created_at`, oldest first. Keep paginating for as long as a `next_cursor` is returned.",
          "items": {
            "type": "object",
            "required": [
              "id",
              "thread_id",
              "content_plaintext",
              "entry",
              "record",
              "resolved_at",
              "resolved_by",
              "created_at",
              "author"
            ],
            "properties": {
              "author": {
                "type": "object",
                "description": "Who wrote this comment. Note that the API provides the ability for API tokens to write comments on behalf of other actors.",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "An ID to identify the actor."
                  },
                  "type": {
                    "type": "string",
                    "description": "The type of actor. [Read more information on actor types here](/docs/actors).",
                    "enum": [
                      "api-token",
                      "workspace-member",
                      "system",
                      "app"
                    ]
                  }
                }
              },
              "content_plaintext": {
                "type": "string",
                "description": "A plaintext representation of the content of the comment. References to workspace members are cast into email addresses, all other stylistic elements are removed."
              },
              "created_at": {
                "type": "string",
                "description": "When the note was created."
              },
              "entry": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "The entry the comment belongs to, `null` for comments on records.",
                "required": [
                  "entry_id",
                  "list_id"
                ],
                "properties": {
                  "entry_id": {
                    "type": "string",
                    "format": "uuid",
                    "description": "The ID of the entry the comment belongs to."
                  },
                  "list_id": {
                    "type": "string",
                    "format": "uuid",
                    "description": "The ID of the list the entry belongs to."
                  }
                }
              },
              "id": {
                "type": "object",
                "required": [
                  "workspace_id",
                  "comment_id"
                ],
                "properties": {
                  "comment_id": {
                    "type": "string",
                    "format": "uuid",
                    "description": "The ID of the comment."
                  },
                  "workspace_id": {
                    "type": "string",
                    "format": "uuid",
                    "description": "The ID of the workspace the comment belongs to."
                  }
                }
              },
              "record": {
                "type": "object",
                "description": "The record the comment belongs to.",
                "required": [
                  "record_id",
                  "object_id"
                ],
                "properties": {
                  "object_id": {
                    "type": "string",
                    "format": "uuid",
                    "description": "The ID of the object the record belongs to."
                  },
                  "record_id": {
                    "type": "string",
                    "format": "uuid",
                    "description": "The ID of the record the comment belongs to."
                  }
                }
              },
              "resolved_at": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Whether the comment is resolved."
              },
              "resolved_by": {
                "type": "object",
                "description": "The actor that resolved this comment.",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "An ID to identify the actor."
                  },
                  "type": {
                    "type": "string",
                    "description": "The type of actor. [Read more information on actor types here](/docs/actors).",
                    "enum": [
                      "api-token",
                      "workspace-member",
                      "system",
                      "app"
                    ]
                  }
                }
              },
              "thread_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the thread the comment belongs to."
              }
            }
          }
        },
        "created_at": {
          "type": "string",
          "description": "When the thread was created."
        },
        "id": {
          "type": "object",
          "required": [
            "thread_id",
            "workspace_id"
          ],
          "properties": {
            "thread_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the thread."
            },
            "workspace_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the workspace the thread belongs to."
            }
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "required": [
        "next_cursor"
      ],
      "properties": {
        "next_cursor": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}