Get comment

Get a comment on a design.

Gets a comment. For information on comments and how they're used in the Canva UI, see the Canva Help Center.

GET 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.

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.

#Authorizationstring
Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

#designIdstring
Required

The design ID.

#commentIdstring
Required

The id of the comment.

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}'
sh

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

#commentComment

The comment object, which contains metadata about the comment.

Properties of comment
#typestring

This can be one of the following:

  • parent: The type of comment. When creating a new parent (top-level) comment, the type is parent.
  • reply: The type of comment. When creating a reply to a top-level comment, the type is reply.
#idstring

The ID of the comment.

You can use this ID to create replies to the comment using the Create reply API.

#messagestring

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].

#authorUser

Metadata for the user, consisting of the User ID and display name.

Properties of author
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#mentionsobject

The Canva users mentioned in the comment.

Properties of mentions
#<KEY>object of TeamUsers

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"
}
}
json
#user_idstring
Optional

The ID of the user.

#team_idstring
Optional

The ID of the user's Canva Team.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#thread_idstring
Conditional

The ID of the comment thread this reply is in. This ID is the same as the id of the parent comment.

#attached_toCommentObject
Optional

Identifying information about the object (such as a design) that the comment is attached to.

Properties of attached_to
#typestring

This can be one of the following:

  • design: If the comment is attached to a Canva Design.
#design_idstring

The ID of the design this comment is attached to.

#created_atinteger
Optional

When the comment or reply was created, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger
Optional

When the comment or reply was last updated, as a Unix timestamp (in seconds since the Unix Epoch).

#assigneeUser
Optional

Metadata for the user, consisting of the User ID and display name.

Properties of assignee
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#resolverUser
Optional

Metadata for the user, consisting of the User ID and display name.

Properties of resolver
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

{
"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"
}
}
}
json

To get started, generate an access token or provide your own below