643 matches
49 actions
Attio
49 actions
CRM/Attio
List threads of comments on a record or list entry.
Each thread in the response includes at most 80 replies, starting with the oldest. When a thread holds more, its has_more_comments is true; use to page through every comment in that thread.
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.
{
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"format": "uuid",
"description": "Use this parameter to filter to threads on a specific entry. Must be passed with `list`."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to return. The default is `10` and the maximum is `50`. See the [full guide to pagination here](/rest-api/guides/pagination)."
},
"list": {
"type": "string",
"description": "Use this parameter to filter to threads on a specific entry. Must be passed with `entry_id`. Accepts either a slug or an ID."
},
"object": {
"type": "string",
"description": "Use this parameter to filter to threads on a specific record. Must be passed with `record_id`. Accepts either a slug or an ID."
},
"offset": {
"type": "integer",
"description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/guides/pagination)."
},
"record_id": {
"type": "string",
"format": "uuid",
"description": "Use this parameter to filter to threads on a specific record. Must be passed with `object`."
}
},
"additionalProperties": false
}{
"type": "object",
"description": "Success",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"created_at",
"comments"
],
"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": [
"workspace_id",
"thread_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."
}
}
}
}
}
}
}
}