Gets a comment. For information on comments and how they're used in the Canva UI, see the Canva Help Center.
HTTP method and URL path
https://api.canva.com /rest /v1 /designs/{designId}/comments/{commentId}
This operation is rate limited to 100 requests per minute for each user of your integration.
Authentication
This endpoint requires a valid access token that acts on behalf of a user. The token must have the following scopes (permissions):
comment:read
For more information, see Scopes.
Header parameters
Path parameters
Example request
Examples for using the /v1/designs/{designId}/comments/{commentId}
endpoint:
curl --request GET 'https://api.canva.com/rest/v1/designs/{designId}/comments/{commentId}' \--header 'Authorization: Bearer {token}'
Success response
If successful, the endpoint returns a 200
response with a JSON body with the following parameters:
The comment object, which contains metadata about the comment.
Properties of comment
This can be one of the following:
parent
: The type of comment. When creating a new parent (top-level) comment, thetype
isparent
.reply
: The type of comment. When creating a reply to a top-level comment, thetype
isreply
.
The ID of the comment.
You can use this ID to create replies to the comment using the Create reply API.
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]
.
The Canva users mentioned in the comment.
Properties of mentions
Metadata for the user, consisting of the User ID, Team ID, and display name.
{"oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {"user_id": "oUnPjZ2k2yuhftbWF7873o","team_id": "oBpVhLW22VrqtwKgaayRbP","display_name": "John Doe"}}
The ID of the comment thread this reply is in. This ID is the same as the id
of the
parent comment.
When the comment or reply was created, as a Unix timestamp (in seconds since the Unix Epoch).
When the comment or reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
Example response
{"comment": {"type": "parent","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"}}}