Skip to main content
Canva logo
  • Category: images & design
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 53
  • Triggers: 0
  • Slug: CANVA
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Canva OAuth credentials with Composio, see How to create OAuth credentials for Canva.

Tools

Slug: CANVA_ACCESS_USER_SPECIFIC_BRAND_TEMPLATES_LISTLists brand templates available to users on plans with brand-template access, such as Canva Pro, Canva Teams, or Canva Enterprise. Returns one page of template metadata, including IDs and titles. Follow the response’s continuation token to retrieve additional pages. Dataset definitions are available from CANVA_RETRIEVE_BRAND_TEMPLATE_DATASET_DEFINITION.

Input Parameters

integer
The number of brand templates to return (1-100, default 25).
string
Lets you search the brand templates available to the user using a search term or terms.
string ("any" | "non_empty")
Filter the list of brand templates based on the brand templates’ dataset definitions. Brand templates with dataset definitions are mainly used with the Autofill APIs. This can be one of the following: - any: (Default) Brand templates with and without dataset definitions. - non_empty: Brand templates with one or more data fields defined.
string ("relevance" | "modified_descending" | "modified_ascending" | "title_descending" | "title_ascending")
Sort the list of brand templates. This can be one of the following: - relevance: (Default) Sort results using a relevance algorithm. - modified_descending: Sort results by the date last modified in descending order. - modified_ascending: Sort results by the date last modified in ascending order. - title_descending: Sort results by title in descending order. - title_ascending: Sort results by title in ascending order.
string ("any" | "owned" | "shared")
Filter the list of brand templates based on the user”s ownership of the brand templates. This can be one of the following: - any: (Default) Brand templates owned by and shared with the user. - owned: Brand templates owned by the user. - shared: Brand templates shared with the user.
string
If the success response contains a continuation token, the user has access to more brand templates you can list. You can use this token as a query parameter and retrieve more templates from the list, for example /v1/brand-templates?continuation={continuation}. To retrieve all the brand templates available to the user, you might need to make multiple requests. IMPORTANT: This token is an opaque value returned by the API. You must use it exactly as returned from a previous API response. Do not manually construct or modify continuation tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_ASSET_UPLOAD_JOBUploads an asset file to the user’s Canva content library. This endpoint initiates an asynchronous upload job for images or videos. Returns a job ID to track the upload progress. Once complete, the asset can be used in designs, referenced by its asset ID, and managed through other asset endpoints. IMPORTANT: This is an async operation. Use CANVA_FETCH_ASSET_UPLOAD_JOB_STATUS to poll the job status until it reaches ‘success’ or ‘failed’ status.

Input Parameters

object
required
Image or video file to upload directly to Canva. Direct upload is the path for large files and for videos larger than the URL-upload limit. No duplicate detection: uploading the same file creates a new asset.
string
required
Display name for the asset (maximum 50 characters). The name can be changed later with the Update asset API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_CANVA_DESIGN_EXPORT_JOBStarts a deprecated asynchronous Canva design export job in PNG, JPG, GIF, PDF, PPTX, MP4, HTML bundle, standalone HTML, or CSV format. Export options vary by format; poll the job for completion and download URLs.

Input Parameters

string
required
Export format configuration. Set ‘type’ to one of: ‘png’, ‘jpg’, ‘pdf’, ‘gif’, ‘mp4’, ‘pptx’, ‘html_bundle’, ‘html_standalone’, or ‘csv’.
string
required
The design ID to export

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_CANVA_DESIGN_WITH_OPTIONAL_ASSETDEPRECATED: Use CANVA_POST_DESIGNS instead. Creates a new Canva design with specified dimensions or from an asset. This endpoint creates a design using either a preset type (doc, email, presentation, whiteboard), custom dimensions, or by importing an image asset. Returns the design ID, URLs for editing and viewing, owner info, and metadata. The design can be immediately accessed and edited.

Input Parameters

string
Design title (1-255 chars). Appears in Canva UI and design lists.
string
Image asset ID to create design from. Optional if design_type provided. IMPORTANT: Only image assets are supported - video and PDF assets will be rejected by the API with error ‘asset_id must belong to an image asset’. Asset IDs are opaque strings with no guaranteed format. To verify an asset is an image before using it here, call CANVA_RETRIEVE_ASSET_METADATA_BY_ID and check that the ‘type’ field equals ‘image’. To upload a new image asset, use CANVA_CREATE_URL_ASSET_UPLOAD_JOB or CANVA_CREATE_ASSET_UPLOAD_JOB.
object
Design dimensions configuration. Optional if asset_id provided. Must be a dictionary with ‘type’ field. Two options: 1. Preset: {‘type’: ‘preset’, ‘name’: ‘doc’|‘email’|‘whiteboard’|‘presentation’} 2. Custom: {‘type’: ‘custom’, ‘width’: 1080, ‘height’: 1920} Type must be either ‘preset’ or ‘custom’. For preset, name must be one of: doc, email, whiteboard, presentation. For custom, width and height must be between 40-8000 pixels and their product must not exceed 25,000,000 pixels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_COMMENT_REPLY_IN_DESIGNDEPRECATED: Use CANVA_POST_DESIGNS_DESIGNID_COMMENTS_THREADID_REPLIES instead. 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.

Input Parameters

string
Deprecated alias for message_plaintext.
string
The design ID. Must match pattern ^[a-zA-Z0-9_-]{1,50}$.
string
The thread ID. Must match pattern ^[a-zA-Z0-9_-]{1,50}$.
object
The object the comment is attached to.
string
The reply comment message. This is the reply comment body shown in the Canva UI. You can also mention users in your message by specifying their User ID and Team ID using the format [user_id:team_id].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_DESIGN_COMMENT_IN_PREVIEW_APIDEPRECATED: Use CANVA_POST_DESIGNS_DESIGNID_COMMENTS instead. Creates a new comment thread on a Canva design using Canva’s deprecated Create comment API. This preview API allows adding text comments to designs for collaboration and feedback. Returns the created comment with ID, author info, and timestamp. Comments can be replied to using the comment reply endpoint.

Input Parameters

string
required
Comment text (1-2048 chars). Mention users with [user_id:team_id]. No markdown support. Comments appear unpinned - users must view ‘All pages’ to see them.
string
Design ID to attach comment to
string
User ID to assign this comment to. If provided, you must also mention this user in the message text using format [user_id:team_id].
object
Target reference for comment attachment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_DESIGN_IMPORT_JOBStarts an asynchronous import of an external document or design file into Canva designs, including PDF, Word, PowerPoint, Excel, PSD, and AI files. Returns a job ID for tracking the import; an import can produce multiple designs.

Input Parameters

object
required
Document or design file to import. Supported formats: AI, PSD, Affinity (.af, .afdesign, .afphoto, .afpub), Keynote, Numbers, Pages, XLS/XLSX, PPT/PPTX, DOC/DOCX, ODG, ODP, ODS, ODT, and PDF.
string
required
Title for the imported design (maximum 50 characters). Shows in Canva UI and design lists.
string
Optional MIME type override. It is normalized to a lowercase media type without parameters. If omitted, Canva attempts to detect the file type automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_DESIGN_MERGE_JOBStart a preview job that creates or modifies a design using page operations. New designs support page insertion. Existing designs support insert, move, and delete operations. Poll the returned ID with CANVA_GET_DESIGN_MERGE_JOB.

Input Parameters

string ("create_new_design" | "modify_existing_design")
required
Whether to create a new design or modify an existing design.
string
Title for a new design (required) or optional replacement title for a modified design.
string
ID of the target design. Required only when modifying a design.
array
required
Ordered page operations. Canva supports one operation by default; apps can request enablement for up to 500 operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_DESIGN_RESIZE_JOBCreates a resized copy of an existing design (Canva Pro/Enterprise only). This endpoint creates a new design with different dimensions from an existing one. The resize operation runs asynchronously and preserves content where possible. Returns a job ID to track progress and retrieve the new design once complete. IMPORTANT: This is an async operation. Use CANVA_RETRIEVE_DESIGN_RESIZE_JOB_STATUS to poll the job status until completion to get the resized design ID and access URLs.

Input Parameters

string
required
The source design ID
string
required
Target design type configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_CREATE_URL_ASSET_UPLOAD_JOBTool to create an asynchronous Canva asset import job from a public URL. Use when you need to import an asset into Canva directly from a publicly accessible URL without S3 choreography.

Input Parameters

string
required
Publicly accessible HTTPS URL of the file to import (8-2048 characters). Canva rejects non-HTTPS URLs.
string
required
Asset name (1-255 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_DELETE_ASSET_BY_IDYou 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.

Input Parameters

string
required
The ID of the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_EXCHANGE_OAUTH20_ACCESS_OR_REFRESH_TOKENThe 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.

Input Parameters

string
Authorization code received after the user authorizes the integration.
string
Optional space-separated subset of previously granted scopes.
string
Integration client ID when credentials are supplied in the request body.
string ("authorization_code" | "refresh_token")
required
OAuth grant type: authorization_code or refresh_token.
string
Redirect URI used for the authorization request, when applicable.
string
Integration client secret when credentials are supplied in the request body.
string
PKCE code verifier used for an authorization-code exchange.
string
Refresh token to exchange when grant_type is refresh_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_FETCH_ASSET_UPLOAD_JOB_STATUSRetrieves the status of a direct asset file upload job. Poll until it succeeds or fails; a successful job can return asset ID and metadata, while a failed job can return error details.

Input Parameters

string
required
The asset upload job ID returned by CANVA_CREATE_ASSET_UPLOAD_JOB or CANVA_POST_ASSET_UPLOADS. This is the ‘id’ field from the job object in the response. IMPORTANT: This tool does NOT work for job IDs from CANVA_CREATE_URL_ASSET_UPLOAD_JOB (URL import jobs use a different endpoint - use CANVA_GET_URL_ASSET_UPLOADS_JOBID instead).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_FETCH_CANVA_CONNECT_SIGNING_PUBLIC_KEYSThe 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_FETCH_CURRENT_USER_DETAILSReturns the User ID and Team ID associated with the provided access token. Use CANVA_RETRIEVE_USER_PROFILE_DATA to retrieve the user’s display name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_FETCH_DESIGN_METADATA_AND_ACCESS_INFORMATIONGets the metadata for a design. This includes owner information, URLs for editing and viewing, and thumbnail information.

Input Parameters

string
required
The design ID (1-50 letters, numbers, underscores, or hyphens), for example DAFVztcvd9z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGN_COMMENT_REPLIESRetrieves a page of replies for a comment or suggestion thread on a design. Returns up to limit replies (default 50, maximum 100); follow the continuation token to retrieve the rest. This is a preview API. Public integrations that use it cannot pass Canva’s review process.

Input Parameters

integer
The number of replies to return. Default is 50. Minimum value: 1, Maximum value: 100.
string
required
The design ID.
string
required
The ID of the thread.
string
Token for pagination to retrieve more items from the list. If the response contains a continuation token, use it to retrieve more replies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGN_COMMENT_REPLYRetrieves a specific reply to a comment or suggestion thread on a design. Use when you need to view details of a particular reply. This is a preview API. Public integrations that use it cannot pass Canva’s review process.

Input Parameters

string
required
The reply identifier. Must match pattern ^[a-zA-Z0-9_-]{1,50}$.
string
required
The design identifier.
string
required
The comment thread identifier. Must match pattern ^[a-zA-Z0-9_-]{1,50}$.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGN_DATASETGet a design’s autofill dataset definition and accepted field types.

Input Parameters

string
required
The Canva design ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGN_EXPORT_JOB_RESULTRetrieves a design export job’s status and result. Poll until the job succeeds or fails; successful jobs can provide download URLs for exported pages, which expire after 24 hours.

Input Parameters

string
required
The export job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGN_GENERATION_JOBRetrieve a design generation job created by the same user and integration. Call repeatedly until the returned status reaches success or failed. The user must have Canva’s design_generation capability. Jobs expire 24 hours after creation, and only the creating user, integration, and team can retrieve them.

Input Parameters

string
required
Public design-generation job ID returned when the job was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGN_MERGE_JOBReturn a design merge job’s current status and result. Call this action repeatedly until the returned status is success or failed.

Input Parameters

string
required
The design merge job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGNS_DESIGNID_COMMENTS_THREADIDRetrieves metadata for a comment or suggestion thread on a design. Use when you need to get details about a specific thread including content, author, timestamps, and status. This is a preview API. Public integrations that use it cannot pass Canva’s review process.

Input Parameters

string
required
The design identifier.
string
required
The thread identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_DESIGNS_DESIGNID_EXPORT_FORMATSLists available file formats for exporting a design. Use this to check which export formats (PDF, JPG, PNG, SVG, PPTX, GIF, MP4, HTML bundle, standalone HTML, and CSV) are supported for a specific design.

Input Parameters

string
required
The design ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_URL_ASSET_UPLOADS_JOBIDTool to retrieve the status and result of a URL-based asset upload job. Use this after creating a URL asset upload job to check progress and retrieve the uploaded asset ID when successful.

Input Parameters

string
required
The asset upload job identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_URL_IMPORTS_JOBIDRetrieves the status and result of a URL import job. Repeatedly check until it succeeds or fails; a successful result contains imported designs and their metadata, while a failed job returns an error.

Input Parameters

string
required
The URL import job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_GET_USERS_ME_CAPABILITIESLists the API capabilities for the user account associated with the provided access token. Use when you need to check what features are available based on the user’s Canva plan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_INITIATE_CANVA_DESIGN_AUTOFILL_JOBCreates an asynchronous autofill job from a brand template or existing design, or updates an existing design in place. Canva Enterprise users are eligible; paid-plan users can use a limited development trial. Poll the returned job ID with CANVA_RETRIEVE_DESIGN_AUTOFILL_JOB_STATUS.

Input Parameters

object
required
Data object containing the data fields and values to autofill. Keys are field names from the brand template. Values can be text, image, video, chart, or sheet data fields.
string ("create_from_brand_template" | "create_from_design" | "update_design")
Autofill source and behavior. Defaults to create_from_brand_template.
string
Title to use for the autofilled design. Must be less than 256 characters. If no design title is provided, the autofilled design will have the same title as the brand template.
string
Source or target design ID for create_from_design or update_design.
string
ID of the input brand template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_LIST_DESIGN_PAGES_WITH_PAGINATIONPreview 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.

Input Parameters

integer
The number of pages to return, starting at the page index specified using the offset parameter. Default is 50 pages. Minimum: 1, Maximum: 200.
integer
The page index to start the range of pages to return. Default is 1. Pages are indexed using one-based numbering, so the first page in a design has the index value 1. Minimum: 1, Maximum: 500.
string
required
The design ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_LIST_FOLDER_ITEMS_BY_TYPE_WITH_SORTINGLists folder items, including folders, designs, image assets, and brand templates. Brand templates are returned only when explicitly requested in item_types and the user’s plan supports them. Video assets are currently not returned.

Input Parameters

integer
The number of folder items to return (1-100, default 50).
string ("created_ascending" | "created_descending" | "modified_ascending" | "modified_descending" | "title_ascending" | "title_descending")
Sort the list of folder items. This can be one of the following: - created_ascending: Sort results by creation date, in ascending order. - created_descending: Sort results by creation date, in descending order. - modified_ascending: Sort results by the last modified date, in ascending order. - modified_descending: (Default) Sort results by the last modified date, in descending order. - title_ascending: Sort results by title, in ascending order. The title is either the name field for a folder or asset, or the title field for a design. - title_descending: Sort results by title, in descending order. The title is either the name field for a folder or asset, or the title field for a design.
string
required
The folder ID. Must be a non-empty string. Use ‘root’ to list items in the root folder.
array
Filter the folder items to only return specified types. The available types are: brand_template, design, folder, and image. To filter for more than one item type, provide a comma- delimited list.
string ("any" | "pinned")
Filter by pinned status: ‘any’ returns all items and ‘pinned’ returns only pinned items.
string
If the success response contains a continuation token, the folder contains more items you can list. You can use this token as a query parameter and retrieve more items from the list, for example /v1/folders/{folderId}/items?continuation={continuation}. To retrieve all the items in a folder, you might need to make multiple requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_LIST_USER_DESIGNSLists one page of Canva user design metadata, with search, ownership filtering for owned and shared designs, and sorting options. Use the response continuation token to retrieve further pages.

Input Parameters

integer
The number of designs to return. Minimum 1, maximum 100, default 25.
string
Lets you search the user”s designs, and designs shared with the user, using a search term or terms.
string ("relevance" | "modified_descending" | "modified_ascending" | "title_descending" | "title_ascending")
Sort the list of designs. This can be one of the following: - relevance: (Default) Sort results using a relevance algorithm. - modified_descending: Sort results by the date last modified in descending order. - modified_ascending: Sort results by the date last modified in ascending order. - title_descending: Sort results by title in descending order. - title_ascending: Sort results by title in ascending order.
string ("any" | "owned" | "shared")
Filter the list of designs based on the user”s ownership of the designs. This can be one of the following: - owned: Designs owned by the user. - shared: Designs shared with the user. - any: Designs owned by and shared with the user.
string
If the success response contains a continuation token, the list contains more designs you can list. You can use this token as a query parameter and retrieve more designs from the list, for example /v1/designs?continuation={continuation}. To retrieve all of a user”s designs, you might need to make multiple requests. Pass a valid token or omit this parameter entirely. Empty strings are not accepted by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_MOVE_ITEM_TO_SPECIFIED_FOLDERTransfers 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.

Input Parameters

string
required
The ID of the item you want to move. Item IDs are alphanumeric strings, 1-50 characters. Design IDs have format like ‘DAFVztcvd9z’, folder IDs like ‘FAF2lZtloor’, and asset IDs like ‘Msd59349ff’. Obtain item IDs from the List designs, List folder items, or other Canva API endpoints. Note: Video assets are not supported for moving.
string
required
The ID of the folder you want to move the item to (the destination folder). Folder IDs are alphanumeric strings (e.g., ‘FAF2lZtloor’), 1-50 characters. Use the special ID ‘root’ to move the item to the top level of a Canva user’s projects, or ‘uploads’ for the Uploads folder. Obtain folder IDs from the List folder items or Create folder API endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_POST_DESIGNSCreates a Canva design from a preset type, custom dimensions, an image asset, an existing design, or a brand template; an image asset can also be inserted with a preset or custom type. Copying designs and using brand templates are preview features; returns design ID, edit/view URLs, and metadata.

Input Parameters

string ("type_and_asset" | "design" | "brand_template")
Creation mode. Omit or use ‘type_and_asset’ for a preset/custom design or asset; use ‘design’ to copy a design; use ‘brand_template’ to copy a brand template. The copy modes are Canva preview features.
string
Design name (1-255 characters). Appears in Canva UI and design lists.
string
Image asset ID to insert into the design. Currently supports image assets only. Must be a valid asset ID from a previously uploaded asset.
string
ID of the existing Canva design to copy when type is ‘design’
string
Design type configuration. Can be a preset name string (‘doc’, ‘email’, ‘whiteboard’, ‘presentation’) which will be auto-converted to the required format, or a nested object for preset (e.g., {‘type’: ‘preset’, ‘name’: ‘presentation’}) or custom dimensions (e.g., {‘type’: ‘custom’, ‘width’: 1080, ‘height’: 1920})
array
One-based page numbers to copy from a design or brand template. If omitted, all pages are copied.
string
ID of the Canva brand template to copy when type is ‘brand_template’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_POST_DESIGNS_DESIGNID_COMMENTSCreates a comment thread on a Canva design. Use when you need to add feedback or collaboration comments to a specific design. Rate limited to 100 requests per minute per user. This is a preview API. Public integrations that use it cannot pass Canva’s review process.

Input Parameters

string
required
The design ID where the comment will be created. Must match pattern ^[a-zA-Z0-9_-]{1,50}$
string
Optional user ID for assignment. If specified, the assignee must be mentioned in the message using [user_id:team_id] format.
string
required
The comment message in plaintext shown in Canva UI. Must be between 1 and 2048 characters. User mentions use format [user_id:team_id].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_POST_DESIGNS_DESIGNID_COMMENTS_THREADID_REPLIESTool to create a reply to a comment or suggestion thread on a Canva design. Use when you need to respond to existing comments or suggestions. Maximum 100 replies per thread allowed. This is a preview API. Public integrations that use it cannot pass Canva’s review process.

Input Parameters

string
required
The design identifier. Must match pattern ^[a-zA-Z0-9_-]{1,50}$
string
required
The identifier of the thread to reply to. Must match pattern ^[a-zA-Z0-9_-]{1,50}$
string
required
The reply text content. Must be between 1 and 2048 characters. Users can be mentioned using the format [user_id:team_id].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_POST_EXPORTSStarts a new asynchronous job to export a Canva design file. Use when exporting designs to various formats (PDF, JPG, PNG, GIF, PPTX, MP4, CSV, and HTML). Returns a job ID that can be used to poll for completion status and download URLs. IMPORTANT: Format compatibility varies by design type. Before exporting, use the CANVA_GET_DESIGNS_DESIGNID_EXPORT_FORMATS action to check which formats are supported for the specific design. Attempting to export in an unsupported format will result in a 400 error (e.g., ‘png export not supported for this design type’).

Input Parameters

string
required
Export format configuration. Specify the format type and format-specific options. Exported files remain available for download for 24 hours. IMPORTANT: Not all formats are supported for all design types. Use GET /v1/designs/{designId}/export-formats to check which formats are supported for a specific design before exporting. If you request an unsupported format, the API will return a 400 error.
string
required
The identifier of the design to export (e.g., ‘DAGz4y3LDFI’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_POST_FOLDERSTool to create a folder in Canva. Use when you need to organize designs, assets, or create nested folder structures in a user’s projects or uploads folder.

Input Parameters

string
required
The display name for the new folder. Must be 1-255 characters. Duplicate names are allowed.
string
required
The ID of the destination location. Use ‘root’ for top-level projects, ‘uploads’ for the uploads folder, or a specific folder ID to nest within another folder. Must be 1-50 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_POST_URL_IMPORTSTool to start an asynchronous job to import an external file from a URL as a new design in Canva. Use when you need to import a design from a publicly accessible URL. This is an async operation; poll the job status using the job ID until it reaches ‘success’ or ‘failed’.

Input Parameters

string
required
The URL of the file to import. This URL must be accessible from the internet and be publicly available (1-2048 characters).
string
required
Name assigned to the imported design (1-255 characters).
string
Supported design-import MIME type (for example, ‘application/pdf’ or ‘application/vnd.apple.keynote’). It is normalized to a lowercase media type without parameters. Canva attempts automatic detection if omitted or empty (1-100 characters when provided).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_REMOVE_FOLDER_AND_MOVE_CONTENTS_TO_TRASHDeletes a folder by moving the user’s content to Trash and reassigning other users’ content to their top-level projects.

Input Parameters

string
required
The folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_APP_PUBLIC_KEY_SETReturns the Json Web Key Set (public keys) of an app. These keys are used to verify JWTs sent to app backends.

Input Parameters

string
required
The app ID. Must be 1-50 alphanumeric characters, underscores, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_ASSET_METADATA_BY_IDYou can retrieve the metadata of an asset by specifying its assetId.

Input Parameters

string
required
The ID of the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_BRAND_TEMPLATE_DATASET_DEFINITIONGets the dataset definition for a brand template. Available to users on plans with brand-template access, such as Canva Pro, Canva Teams, or Canva Enterprise. Data fields can contain images, text, and charts; chart data is a preview feature.

Input Parameters

string
required
The brand template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_CANVA_ENTERPRISE_BRAND_TEMPLATE_METADATARetrieves metadata for a brand template. Available to users on plans with brand-template access, such as Canva Pro, Canva Teams, or Canva Enterprise.

Input Parameters

string
required
The brand template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_DESIGN_AUTOFILL_JOB_STATUSRetrieves a design autofill job result. Canva Enterprise users are eligible, while paid-plan users can use a limited development trial. Poll until the status is success or failed.

Input Parameters

string
required
The design autofill job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_DESIGN_IMPORT_JOB_STATUSRetrieves a design import job’s status and result. Poll until success or failure; a successful import returns a list of imported designs and their metadata.

Input Parameters

string
required
The design import job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_DESIGN_RESIZE_JOB_STATUSRetrieves the status and results of a design resize job. Polls for design resize job completion status. Use this after CANVA_CREATE_DESIGN_RESIZE_JOB to check the resize progress. Keep polling until status is ‘success’ or ‘failed’. Successful jobs include the new design ID and temporary access URLs.

Input Parameters

string
required
The resize job ID returned from create resize job endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_FOLDER_DETAILS_BY_IDGets the name and other details of a folder using a folder’s folderID.

Input Parameters

string
required
The folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_RETRIEVE_USER_PROFILE_DATACurrently, 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_REVOKE_OAUTH_TOKENSRevoke an access token or refresh token. Revoking a refresh token also revokes 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.

Input Parameters

string
required
The token to revoke.
string
Your integration”s unique ID, for authenticating the request. NOTE: We recommend that you use basic access authentication instead of specifying client_id and client_secret as body parameters.
string
Your integration”s client secret, for authenticating the request. Begins with cnvca. NOTE: We recommend that you use basic access authentication instead of specifying client_id and client_secret as body parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_UPDATE_ASSET_S_NAME_AND_TAGS_BY_IDYou can update the name and tags of an asset by specifying its assetId. Updating the tags replaces all existing tags of the asset.

Input Parameters

string
The name of the asset. This is shown in the Canva UI. When this field is undefined or empty, nothing is updated. Maximum length 50 characters.
array
The replacement tags for the asset. When this field is undefined, nothing is updated. Maximum length 50 tags. Each tag has a maximum length of 50 characters.
string
required
The ID of the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_UPDATE_FOLDER_DETAILS_BY_IDUpdates a folder’s details using its folderID. Currently, you can only update a folder’s name.

Input Parameters

string
required
The folder name, as shown in the Canva UI (1-255 characters).
string
required
The folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_VALIDATE_OAUTH_TOKEN_PROPERTIESCheck 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.

Input Parameters

string
required
The token to introspect.
string
Your integration”s unique ID, for authenticating the request. NOTE: We recommend that you use basic access authentication instead of specifying client_id and client_secret as body parameters.
string
Your integration”s client secret, for authenticating the request. Begins with cnvca. NOTE: We recommend that you use basic access authentication instead of specifying client_id and client_secret as body parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVA_WHO_AM_IReturns the connected Canva account’s user and team IDs and, when available, its profile display name. The top-level display name falls back to the user ID if the profile name is unavailable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not