Canva | Composio Docs

Overview

SLUG

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

OAuth2

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

bearer_token

string

Tools

Revoke oauth tokens

SLUG: CANVA_REVOKE_OAUTH_TOKENS

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

client_id

string

client_secret

string

token

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Access user specific brand templates list

SLUG: CANVA_ACCESS_USER_SPECIFIC_BRAND_TEMPLATES_LIST

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

Action Parameters

continuation

string

dataset

string

ownership

string

query

string

sort_by

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create canva design with optional asset

SLUG: CANVA_CREATE_CANVA_DESIGN_WITH_OPTIONAL_ASSET

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

objectRequired

error

string

successful

booleanRequired

Create comment reply in design

SLUG: CANVA_CREATE_COMMENT_REPLY_IN_DESIGN

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

objectRequired

error

string

successful

booleanRequired

Create design comment in preview api

SLUG: CANVA_CREATE_DESIGN_COMMENT_IN_PREVIEW_API

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

assignee_id

string

message

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create user or sub folder

SLUG: CANVA_CREATE_USER_OR_SUB_FOLDER

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

objectRequired

error

string

successful

booleanRequired

Delete asset by id

SLUG: CANVA_DELETE_ASSET_BY_ID

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

objectRequired

error

string

successful

booleanRequired

Exchange oauth 2 0 access or refresh token

SLUG: CANVA_EXCHANGE_OAUTH_2_0_ACCESS_OR_REFRESH_TOKEN

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

objectRequired

error

string

successful

booleanRequired

Fetch asset upload job status

SLUG: CANVA_FETCH_ASSET_UPLOAD_JOB_STATUS

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

objectRequired

error

string

successful

booleanRequired

Fetch canva connect signing public keys

SLUG: CANVA_FETCH_CANVA_CONNECT_SIGNING_PUBLIC_KEYS

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

objectRequired

error

string

successful

booleanRequired

Fetch current user details

SLUG: CANVA_FETCH_CURRENT_USER_DETAILS

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

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Fetch design metadata and access information

SLUG: CANVA_FETCH_DESIGN_METADATA_AND_ACCESS_INFORMATION

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

objectRequired

error

string

successful

booleanRequired

Get design export job result

SLUG: CANVA_GET_DESIGN_EXPORT_JOB_RESULT

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

objectRequired

error

string

successful

booleanRequired

Initiates canva design export job

SLUG: CANVA_INITIATES_CANVA_DESIGN_EXPORT_JOB

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

objectRequired

error

string

successful

booleanRequired

Initiate canva design autofill job

SLUG: CANVA_INITIATE_CANVA_DESIGN_AUTOFILL_JOB

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

data

objectRequired

title

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

List design pages with pagination

SLUG: CANVA_LIST_DESIGN_PAGES_WITH_PAGINATION

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

limit

integerDefaults to 50

offset

integerDefaults to 1

Action Response

data

objectRequired

error

string

successful

booleanRequired

List folder items by type with sorting

SLUG: CANVA_LIST_FOLDER_ITEMS_BY_TYPE_WITH_SORTING

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](https://www.canva.com/create/documents/)). - image assets.

Action Parameters

continuation

string

folderId

stringRequired

item_types

array

sort_by

stringDefaults to modified_descending

Action Response

data

objectRequired

error

string

successful

booleanRequired

List User Designs

SLUG: CANVA_LIST_USER_DESIGNS

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

Action Parameters

continuation

string

ownership

string

query

string

sort_by

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Move item to specified folder

SLUG: CANVA_MOVE_ITEM_TO_SPECIFIED_FOLDER

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

item_id

stringRequired

to_folder_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Remove folder and move contents to trash

SLUG: CANVA_REMOVE_FOLDER_AND_MOVE_CONTENTS_TO_TRASH

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

objectRequired

error

string

successful

booleanRequired