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.
- 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 API. For information on comments and how they're used in the Canva UI, see the Canva Help Center.
Path parameters
The design ID.
The ID of the thread.
Response
OK
Example response
{
"comment": {
"id": "KeAbiEAjZEj",
"attached_to": {
"design_id": "DAFVztcvd9z",
"type": "design"
},
"message": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
"author": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
},
"created_at": 1692928800,
"updated_at": 1692928900,
"mentions": {
"oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
"user_id": "oUnPjZ2k2yuhftbWF7873o",
"team_id": "oBpVhLW22VrqtwKgaayRbP",
"display_name": "John Doe"
}
},
"assignee": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
},
"resolver": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
}
},
"thread": {
"id": "KeAbiEAjZEj",
"design_id": "DAFVztcvd9z",
"thread_type": {
"content": {
"plaintext": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
"markdown": "*_Great work_* [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!"
},
"mentions": {
"oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
"tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP",
"user": {
"user_id": "oUnPjZ2k2yuhftbWF7873o",
"team_id": "oBpVhLW22VrqtwKgaayRbP",
"display_name": "John Doe"
}
}
},
"assignee": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
},
"resolver": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
}
},
"author": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
},
"created_at": 1692928800,
"updated_at": 1692928900
}
}Changes
Changed in 2 of the 8 revisions of this API.9
- ●
added the new
design_generation_rejectedenum value to thecoderesponse property for the response status403response-property-enum-value-added
- ●
added the new
design_generation_rejectedenum value to thecoderesponse property for the response status404response-property-enum-value-added
- ●
added the new
design_generation_rejectedenum value to thecoderesponse property for the response statusdefaultresponse-property-enum-value-added
- ●
- ●
added the new
domain_restrictedenum value to thecoderesponse property for the response status403response-property-enum-value-added
- ●
added the new
domain_restrictedenum value to thecoderesponse property for the response status404response-property-enum-value-added
- ●
added the new
domain_restrictedenum value to thecoderesponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
user_already_memberenum value to thecoderesponse property for the response status403response-property-enum-value-added
- ●
added the new
user_already_memberenum value to thecoderesponse property for the response status404response-property-enum-value-added
- ●
added the new
user_already_memberenum value to thecoderesponse property for the response statusdefaultresponse-property-enum-value-added
- ●