--- title: "GET /v1/designs/{designId}/comments/{threadId}" method: GET path: "/v1/designs/{designId}/comments/{threadId}" tags: ["comment"] --- # GET /v1/designs/{designId}/comments/{threadId} `GET /v1/designs/{designId}/comments/{threadId}` This API is currently provided as a preview. Be aware of the following: - There might be unannounced breaking changes. - Any breaking changes to preview APIs won't produce a new [API version](https://www.canva.dev/docs/connect/versions/). - Public integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users. Gets a comment or suggestion thread on a design. To retrieve a reply to a comment thread, use the [Get reply](https://www.canva.dev/docs/connect/api-reference/comments/get-reply/) API. For information on comments and how they're used in the Canva UI, see the [Canva Help Center](https://www.canva.com/help/comments/). ## Path parameters - `designId` string, required - `threadId` string, required ## Response `200` OK - GetThreadResponse — Successful response from a `getThread` request. The `comment` property is deprecated. For details of a comment thread, please use the `thread` property. - `comment` union — The comment object, which contains metadata about the comment. Deprecated in favor of the new `thread` object. - object — Data about the comment, including the message, author, and the object (such as a design) the comment is attached to. - `type` 'parent', required - `id` string, required — The ID of the comment. You can use this ID to create replies to the comment using the [Create reply API](https://www.canva.dev/docs/connect/api-reference/comments/create-reply/). - `attached_to` CommentObject — If the comment is attached to a Canva Design. - `type` 'design', required - `design_id` string, required — The ID of the design this comment is attached to. - `message` string, required — The comment message. This is the comment body shown in the Canva UI. User mentions are shown here in the format `[user_id:team_id]`. - `author` User, required — Metadata for the user, consisting of the User ID and display name. - `id` string, required — The ID of the user. - `display_name` string — The name of the user as shown in the Canva UI. - `created_at` integer — When the comment or reply was created, as a Unix timestamp (in seconds since the Unix Epoch). - `updated_at` integer — When the comment or reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch). - `mentions` object, required — The Canva users mentioned in the comment. - `assignee` User — Metadata for the user, consisting of the User ID and display name. - `id` string, required — The ID of the user. - `display_name` string — The name of the user as shown in the Canva UI. - `resolver` User — Metadata for the user, consisting of the User ID and display name. - `id` string, required — The ID of the user. - `display_name` string — The name of the user as shown in the Canva UI. - object — Data about the reply comment, including the message, author, and the object (such as a design) the comment is attached to. - `type` 'reply', required - `id` string, required — The ID of the comment. - `attached_to` CommentObject — If the comment is attached to a Canva Design. - `type` 'design', required - `design_id` string, required — The ID of the design this comment is attached to. - `message` string, required — The comment message. This is the comment body shown in the Canva UI. User mentions are shown here in the format `[user_id:team_id]`. - `author` User, required — Metadata for the user, consisting of the User ID and display name. - `id` string, required — The ID of the user. - `display_name` string — The name of the user as shown in the Canva UI. - `created_at` integer — When the comment or reply was created, as a Unix timestamp (in seconds since the Unix Epoch). - `updated_at` integer — When the comment or reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch). - `mentions` object, required — The Canva users mentioned in the comment. - `thread_id` string, required — The ID of the comment thread this reply is in. This ID is the same as the `id` of the parent comment. - `thread` Thread — A discussion thread on a design. The `type` of the thread can be found in the `thread_type` object, along with additional type-specific properties. The `author` of the thread might be missing if that user account no longer exists. - `id` string, required — The ID of the thread. You can use this ID to create replies to the thread using the [Create reply API](https://www.canva.dev/docs/connect/api-reference/comments/create-reply/). - `design_id` string, required — The ID of the design that the discussion thread is on. - `thread_type` union, required — The type of the discussion thread, along with additional type-specific properties. - object — A comment thread. - `type` 'comment', required - `content` CommentContent, required — The content of a comment thread or reply. - `plaintext` string, required — The content in plaintext. Any user mention tags are shown in the format `[user_id:team_id]`. - `markdown` string — The content in markdown. Any user mention tags are shown in the format `[user_id:team_id]` - `mentions` object, required — The Canva users mentioned in the comment thread or reply. - `assignee` User — Metadata for the user, consisting of the User ID and display name. - `id` string, required — The ID of the user. - `display_name` string — The name of the user as shown in the Canva UI. - `resolver` User — Metadata for the user, consisting of the User ID and display name. - `id` string, required — The ID of the user. - `display_name` string — The name of the user as shown in the Canva UI. - object — A suggestion thread. - `type` 'suggestion', required - `suggested_edits` SuggestedEdit[], required - union — The type of the suggested edit, along with additional type-specific properties. - object — A suggestion to add some text. - … - object — A suggestion to delete some text. - … - object — A suggestion to format some text. - … - `status` 'open' | 'accepted' | 'rejected', required — The current status of the suggestion. - `author` User — Metadata for the user, consisting of the User ID and display name. - `id` string, required — The ID of the user. - `display_name` string — The name of the user as shown in the Canva UI. - `created_at` integer, required — When the thread was created, as a Unix timestamp (in seconds since the Unix Epoch). - `updated_at` integer, required — When the thread was last updated, as a Unix timestamp (in seconds since the Unix Epoch). ## Other responses - `403` — Forbidden - `404` — Not Found - `default` — Error Response --- [API](https://skmtc.net/canva/apis/canva-connect-api.md) · [All operations](https://skmtc.net/canva/apis/canva-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/canva/canva-connect-api/versions/499c392c7720/schema)