Canva

Learn how to use Canva with Composio

Overview

Enum

CANVA

Description

Canva offers a drag-and-drop design suite for creating social media graphics, presentations, and marketing materials with prebuilt templates and a vast element library

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to app:read,app:write,asset:read,asset:write,brandtemplate:content:read,brandtemplate:meta:read,comment:read,comment:write,design:content:read,design:content:write,design:meta:read,design:permission:read,design:permission:write,folder:read,folder:write,folder:permission:read,folder:permission:write,profile:read

Actions

Upcoming update will change brand template ids; integrations must migrate within 6 months. api use requires canva enterprise membership.

Action Parameters

brandTemplateId
stringRequired

Action Response

data
object
successful
boolean
error

Create a new canva design using a preset or custom dimensions, and add an asset with asset id from a user’s project using relevant apis.

Action Parameters

asset_id
string
title
string

Action Response

data
object
successful
boolean
error

Check an access token’s validity and properties via introspection, requiring authentication. use basic access (base64 encoded client id:client secret) or body parameters for credentialing.

Action Parameters

token
stringRequired
client_id
string
client_secret
string

Action Response

data
object
successful
boolean
error

This year, brand template ids will change; integrations storing them must update within 6 months. also, api use requires canva enterprise membership.

Action Parameters

query
string
continuation
string
ownership
string
sort_by
string
dataset
string

Action Response

data
object
successful
boolean
error

This preview api allows replying to comments within a design on canva, with a limit of 100 replies per comment. users should note potential unannounced changes, and that preview apis are not eligible for public integrations.

Action Parameters

commentId
stringRequired
message
stringRequired

Action Response

data
object
successful
boolean
error

Transfers an item to a different folder by specifying both the destination folder’s id and the item’s id. if the item is in various folders, an error occurs; manual relocation via canva ui is required.

Action Parameters

to_folder_id
stringRequired
item_id
stringRequired

Action Response

data
object
successful
boolean
error

Revoke a refresh token to end its lineage and user consent, requiring re-authentication. authenticate using either basic access with base64-encoded credentials or body parameters with client id and secret.

Action Parameters

token
stringRequired
client_id
string
client_secret
string

Action Response

data
object
successful
boolean
error

This preview api is subject to unannounced changes and can’t be used in public integrations. it retrieves a comment, details of which are on canva help center.

Action Parameters

designId
stringRequired
commentId
stringRequired

Action Response

data
object
successful
boolean
error

The oauth 2.0 endpoint issues time-limited (4-hour) access tokens of up to 4kb for user authorization via codes or refresh tokens. it requires client id/secret for authentication.

Action Parameters

Action Response

data
object
successful
boolean
error

Get the outcome of a canva design export job; if done, receive download links for the design’s pages. for details, visit the create design export job api documentation.

Action Parameters

exportId
stringRequired

Action Response

data
object
successful
boolean
error

This api creates a folder in a canva user’s projects at the top level or within another folder, returning the new folder’s id and additional details upon success.

Action Parameters

name
stringRequired
parent_folder_id
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a folder by moving the user’s content to trash and reassigning other users’ content to their top-level projects.

Action Parameters

folderId
stringRequired

Action Response

data
object
successful
boolean
error

Currently, this returns the display name of the user account associated with the provided access token. more user information is expected to be included in the future.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns the user id, team id, and display name of the user account associated with the provided access token.

Action Parameters

Action Response

data
object
successful
boolean
error

Preview api for canva: subject to unannounced changes and not for public integrations. lists metadata for design pages with optional offset and limit; not applicable to all design types.

Action Parameters

designId
stringRequired
offset
integerDefaults to 1
limit
integerDefaults to 50

Action Response

data
object
successful
boolean
error

This api is in preview and may change without notice; integrations using it won’t pass review. it allows creating comments on a design, with a limit of 1000 comments per design.

Action Parameters

message
stringRequired
assignee_id
string

Action Response

data
object
successful
boolean
error

You can delete an asset by specifying its assetid. this operation mirrors the behavior in the canva ui. deleting an item moves it to the trash. deleting an asset doesn’t remove it from designs that already use it.

Action Parameters

assetId
stringRequired

Action Response

data
object
successful
boolean
error

The api for verifying canva webhooks, ‘connect/keys,’ is in preview, meaning unstable, not for public integrations, and provides a rotating jwk for signature verification to prevent replay attacks. cache keys for efficiency.

Action Parameters

Action Response

data
object
successful
boolean
error

Canva’s new job feature exports designs in multiple formats using a design id, with provided download links. the export status can be tracked via an api. exports with ‘pro’ quality may fail if the design contains unpaid premium elements.

Action Parameters

design_id
stringRequired

Action Response

data
object
successful
boolean
error

Upcoming brand template id updates require migration within 6 months. canva enterprise users can auto-fill designs using various data types, including experimental chart data. monitor jobs with specific api.

Action Parameters

brand_template_id
stringRequired
title
string
data
objectRequired

Action Response

data
object
successful
boolean
error

Lists the items in a folder, including each item’s type. folders can contain: - other folders. - designs, such as instagram posts, presentations, and documents (canva docs). - image assets.

Action Parameters

folderId
stringRequired
continuation
string
item_types
array
sort_by
stringDefaults to modified_descending

Action Response

data
object
successful
boolean
error

Updates a folder’s details using its folderid. currently, you can only update a folder’s name.

Action Parameters

folderId
stringRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

You can retrieve the metadata of an asset by specifying its assetid.

Action Parameters

assetId
stringRequired

Action Response

data
object
successful
boolean
error

Summarize asset upload outcome by repeatedly calling the endpoint until a ‘success’ or ‘failed’ status is received after using the create asset upload job api.

Action Parameters

jobId
stringRequired

Action Response

data
object
successful
boolean
error

You can update the name and tags of an asset by specifying its assetid. updating the tags replaces all existing tags of the asset.

Action Parameters

assetId
stringRequired
name
string
tags
array

Action Response

data
object
successful
boolean
error

Provides a summary of canva user designs, includes search filtering, and allows showing both self-created and shared designs with sorting options.

Action Parameters

query
string
continuation
string
ownership
string
sort_by
string

Action Response

data
object
successful
boolean
error

Api users with canva enterprise membership can retrieve design autofill job results, potentially requiring multiple requests until a success or failed status is received.

Action Parameters

jobId
stringRequired

Action Response

data
object
successful
boolean
error

Gets the name and other details of a folder using a folder’s folderid.

Action Parameters

folderId
stringRequired

Action Response

data
object
successful
boolean
error

Canva’s brand template ids will change later this year, including a 6-month integration migration. api access requires enterprise membership, providing autofill for images, text, and charts, although chart data could change during preview.

Action Parameters

brandTemplateId
stringRequired

Action Response

data
object
successful
boolean
error

Returns the json web key set (public keys) of an app. these keys are used to verify jwts sent to app backends.

Action Parameters

appId
stringRequired

Action Response

data
object
successful
boolean
error

Gets the status and results of design import jobs created using the create design import job api.

Action Parameters

jobId
stringRequired

Action Response

data
object
successful
boolean
error

Gets the metadata for a design. this includes owner information, urls for editing and viewing, and thumbnail information.

Action Parameters

designId
stringRequired

Action Response

data
object
successful
boolean
error