Canva API reference

New to Corsair? See API access, authentication, and error handling.

Assets

delete

assets.delete Delete an asset Risk: destructive

await corsair.canva.api.assets.delete({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—

get

assets.get Get metadata for an asset Risk: read

await corsair.canva.api.assets.get({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	—

Output

Name	Type	Required	Description
`asset`	`object`	Yes	—

asset full type

{
  type: image | video,
  id: string,
  name: string,
  tags: string[],
  created_at: number,
  updated_at: number,
  owner?: {
    user_id: string,
    team_id: string
  },
  thumbnail?: {
    width: number,
    height: number,
    url: string
  }
}

update

assets.update Update an asset name or tags Risk: write

await corsair.canva.api.assets.update({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	—
`name`	`string`	No	—
`tags`	`string[]`	No	—

Output

Name	Type	Required	Description
`asset`	`object`	Yes	—

asset full type

{
  type: image | video,
  id: string,
  name: string,
  tags: string[],
  created_at: number,
  updated_at: number,
  owner?: {
    user_id: string,
    team_id: string
  },
  thumbnail?: {
    width: number,
    height: number,
    url: string
  }
}

Asset Uploads

create

assetUploads.create Start a job to upload an asset from binary content Risk: write

await corsair.canva.api.assetUploads.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`contentBase64`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  asset?: {
    type: image | video,
    id: string,
    name: string,
    tags: string[],
    created_at: number,
    updated_at: number,
    owner?: {
      user_id: string,
      team_id: string
    },
    thumbnail?: {
      width: number,
      height: number,
      url: string
    }
  },
  error?: {
    code: string,
    message: string
  }
}

createFromUrl

assetUploads.createFromUrl Start a job to upload an asset from a URL Risk: write

await corsair.canva.api.assetUploads.createFromUrl({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`url`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  asset?: {
    type: image | video,
    id: string,
    name: string,
    tags: string[],
    created_at: number,
    updated_at: number,
    owner?: {
      user_id: string,
      team_id: string
    },
    thumbnail?: {
      width: number,
      height: number,
      url: string
    }
  },
  error?: {
    code: string,
    message: string
  }
}

get

assetUploads.get Get the status of an asset upload job Risk: read

await corsair.canva.api.assetUploads.get({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  asset?: {
    type: image | video,
    id: string,
    name: string,
    tags: string[],
    created_at: number,
    updated_at: number,
    owner?: {
      user_id: string,
      team_id: string
    },
    thumbnail?: {
      width: number,
      height: number,
      url: string
    }
  },
  error?: {
    code: string,
    message: string
  }
}

getFromUrl

assetUploads.getFromUrl Get the status of a URL asset upload job Risk: read

await corsair.canva.api.assetUploads.getFromUrl({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  asset?: {
    type: image | video,
    id: string,
    name: string,
    tags: string[],
    created_at: number,
    updated_at: number,
    owner?: {
      user_id: string,
      team_id: string
    },
    thumbnail?: {
      width: number,
      height: number,
      url: string
    }
  },
  error?: {
    code: string,
    message: string
  }
}

Autofills

create

autofills.create Start a job to autofill a brand template with data Risk: write

await corsair.canva.api.autofills.create({});

Input

Name	Type	Required	Description
`brand_template_id`	`string`	Yes	—
`data`	`object`	Yes	—
`title`	`string`	No	—

data full type

Record<string, {
  type: text,
  text: string
} | {
  type: image,
  asset_id: string
} | {
  type: video,
  asset_id: string
} | {
  type: chart,
  chart_data: Record<string, any>
} | {
  type: sheet,
  sheet_data: Record<string, any>
}>

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    type?: string,
    design?: {
      id: string,
      title?: string,
      url?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      },
      current_page_index?: number
    }
  },
  error?: {
    code: string,
    message: string
  }
}

get

autofills.get Get the status of a design autofill job Risk: read

await corsair.canva.api.autofills.get({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    type?: string,
    design?: {
      id: string,
      title?: string,
      url?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      },
      current_page_index?: number
    }
  },
  error?: {
    code: string,
    message: string
  }
}

Brand Templates

get

brandTemplates.get Get metadata for a brand template Risk: read

await corsair.canva.api.brandTemplates.get({});

Input

Name	Type	Required	Description
`brandTemplateId`	`string`	Yes	—

Output

Name	Type	Required	Description
`brand_template`	`object`	Yes	—

brand_template full type

{
  id: string,
  title?: string,
  view_url?: string,
  create_url?: string,
  thumbnail?: {
    width: number,
    height: number,
    url: string
  },
  created_at?: number,
  updated_at?: number
}

getDataset

brandTemplates.getDataset Get the autofill dataset definition for a brand template Risk: read

await corsair.canva.api.brandTemplates.getDataset({});

Input

Name	Type	Required	Description
`brandTemplateId`	`string`	Yes	—

Output

Name	Type	Required	Description
`dataset`	`object`	Yes	—

dataset full type

Record<string, {
  type: text | image | chart
}>

list

brandTemplates.list List the user’s brand templates Risk: read

await corsair.canva.api.brandTemplates.list({});

Input

Name	Type	Required	Description
`query`	`string`	No	—
`continuation`	`string`	No	—
`limit`	`number`	No	—
`ownership`	`any \| owned \| shared`	No	—
`sort_by`	`relevance \| modified_descending \| modified_ascending \| title_descending \| title_ascending`	No	—
`dataset`	`any \| non_empty`	No	—

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`continuation`	`string`	No	—

items full type

{
  id: string,
  title?: string,
  view_url?: string,
  create_url?: string,
  thumbnail?: {
    width: number,
    height: number,
    url: string
  },
  created_at?: number,
  updated_at?: number
}[]

Comments

createReply

comments.createReply Reply to a comment thread on a design Risk: write

await corsair.canva.api.comments.createReply({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`threadId`	`string`	Yes	—
`message_plaintext`	`string`	Yes	—

Output

Name	Type	Required	Description
`reply`	`object`	Yes	—

reply full type

{
  id: string,
  design_id?: string,
  thread_id?: string,
  author?: {
    id: string,
    display_name?: string
  },
  content?: {
    plaintext?: string,
    markdown?: string
  },
  created_at?: number,
  updated_at?: number
}

createThread

comments.createThread Create a new comment thread on a design Risk: write

await corsair.canva.api.comments.createThread({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`message_plaintext`	`string`	Yes	—
`assignee_id`	`string`	No	—

Output

Name	Type	Required	Description
`thread`	`object`	Yes	—

thread full type

{
  id: string,
  design_id?: string,
  thread_type?: {
    type?: string,
    content?: {
      plaintext?: string,
      markdown?: string
    }
  },
  author?: {
    id: string,
    display_name?: string
  },
  assignee?: {
    id: string,
    display_name?: string
  },
  created_at?: number,
  updated_at?: number
}

getReply

comments.getReply Get a reply to a comment thread on a design Risk: read

await corsair.canva.api.comments.getReply({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`threadId`	`string`	Yes	—
`replyId`	`string`	Yes	—

Output

Name	Type	Required	Description
`reply`	`object`	Yes	—

reply full type

{
  id: string,
  design_id?: string,
  thread_id?: string,
  author?: {
    id: string,
    display_name?: string
  },
  content?: {
    plaintext?: string,
    markdown?: string
  },
  created_at?: number,
  updated_at?: number
}

getThread

comments.getThread Get a comment thread on a design Risk: read

await corsair.canva.api.comments.getThread({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`threadId`	`string`	Yes	—

Output

Name	Type	Required	Description
`thread`	`object`	Yes	—

thread full type

{
  id: string,
  design_id?: string,
  thread_type?: {
    type?: string,
    content?: {
      plaintext?: string,
      markdown?: string
    }
  },
  author?: {
    id: string,
    display_name?: string
  },
  assignee?: {
    id: string,
    display_name?: string
  },
  created_at?: number,
  updated_at?: number
}

listReplies

comments.listReplies List replies to a comment thread on a design Risk: read

await corsair.canva.api.comments.listReplies({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`threadId`	`string`	Yes	—
`continuation`	`string`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`continuation`	`string`	No	—

items full type

{
  id: string,
  design_id?: string,
  thread_id?: string,
  author?: {
    id: string,
    display_name?: string
  },
  content?: {
    plaintext?: string,
    markdown?: string
  },
  created_at?: number,
  updated_at?: number
}[]

Designs

create

designs.create Create a new Canva design Risk: write

await corsair.canva.api.designs.create({});

Input

Name	Type	Required	Description
`type`	`type_and_asset`	No	—
`design_type`	`object`	No	—
`asset_id`	`string`	No	—
`title`	`string`	No	—

design_type full type

{
  type: preset,
  name: doc | email | presentation | whiteboard
} | {
  type: custom,
  width: number,
  height: number
}

Output

Name	Type	Required	Description
`design`	`object`	Yes	—

design full type

{
  id: string,
  title?: string,
  owner: {
    user_id: string,
    team_id: string
  },
  thumbnail?: {
    width: number,
    height: number,
    url: string
  },
  urls: {
    edit_url: string,
    view_url: string
  },
  created_at: number,
  updated_at: number,
  page_count?: number,
  design_types?: string[]
}

get

designs.get Get metadata for a design Risk: read

await corsair.canva.api.designs.get({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—

Output

Name	Type	Required	Description
`design`	`object`	Yes	—

design full type

{
  id: string,
  title?: string,
  owner: {
    user_id: string,
    team_id: string
  },
  thumbnail?: {
    width: number,
    height: number,
    url: string
  },
  urls: {
    edit_url: string,
    view_url: string
  },
  created_at: number,
  updated_at: number,
  page_count?: number,
  design_types?: string[]
}

getExportFormats

designs.getExportFormats Get the export formats available for a design Risk: read

await corsair.canva.api.designs.getExportFormats({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—

Output

Name	Type	Required	Description
`formats`	`object`	Yes	—

formats full type

Record<string, {
  page_numbers?: number[]
}>

getPages

designs.getPages Get pages for a design Risk: read

await corsair.canva.api.designs.getPages({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`offset`	`number`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—

items full type

{
  id?: string,
  index?: number,
  page_number?: number,
  design_type?: string,
  dimensions?: {
    width: number,
    height: number
  },
  thumbnail?: {
    width: number,
    height: number,
    url: string
  }
}[]

list

designs.list List designs in the user projects Risk: read

await corsair.canva.api.designs.list({});

Input

Name	Type	Required	Description
`query`	`string`	No	—
`continuation`	`string`	No	—
`ownership`	`any \| owned \| shared`	No	—
`sort_by`	`relevance \| modified_descending \| modified_ascending \| title_descending \| title_ascending`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`continuation`	`string`	No	—

items full type

{
  id: string,
  title?: string,
  owner: {
    user_id: string,
    team_id: string
  },
  thumbnail?: {
    width: number,
    height: number,
    url: string
  },
  urls: {
    edit_url: string,
    view_url: string
  },
  created_at: number,
  updated_at: number,
  page_count?: number,
  design_types?: string[]
}[]

Exports

create

exports.create Start a design export job Risk: write

await corsair.canva.api.exports.create({});

Input

Name	Type	Required	Description
`design_id`	`string`	Yes	—
`format`	`object`	Yes	—

format full type

{
  type: pdf,
  size?: a4 | a3 | letter | legal,
  pages?: number[],
  export_quality?: regular | pro
} | {
  type: jpg,
  quality: number,
  width?: number,
  height?: number,
  pages?: number[],
  export_quality?: regular | pro
} | {
  type: png,
  width?: number,
  height?: number,
  pages?: number[],
  lossless?: boolean,
  transparent_background?: boolean,
  as_single_image?: boolean,
  export_quality?: regular | pro
} | {
  type: gif,
  width?: number,
  height?: number,
  pages?: number[],
  export_quality?: regular | pro
} | {
  type: pptx,
  pages?: number[]
} | {
  type: mp4,
  quality?: horizontal_480p | horizontal_720p | horizontal_1080p | horizontal_4k | vertical_480p | vertical_720p | vertical_1080p | vertical_4k
} | {
  type: html_bundle,
  pages?: number[]
} | {
  type: html_standalone,
  pages?: number[]
} | {
  type: csv,
  pages?: number[]
}

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  urls?: string[],
  error?: {
    code: string,
    message: string
  }
}

get

exports.get Get the status of an export job Risk: read

await corsair.canva.api.exports.get({});

Input

Name	Type	Required	Description
`exportId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  urls?: string[],
  error?: {
    code: string,
    message: string
  }
}

Folders

create

folders.create Create a folder Risk: write

await corsair.canva.api.folders.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`parent_folder_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`folder`	`object`	Yes	—

folder full type

{
  id: string,
  name: string,
  created_at: number,
  updated_at: number,
  thumbnail?: {
    width: number,
    height: number,
    url: string
  }
}

delete

folders.delete Delete a folder Risk: destructive

await corsair.canva.api.folders.delete({});

Input

Name	Type	Required	Description
`folderId`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—

get

folders.get Get metadata for a folder Risk: read

await corsair.canva.api.folders.get({});

Input

Name	Type	Required	Description
`folderId`	`string`	Yes	—

Output

Name	Type	Required	Description
`folder`	`object`	Yes	—

folder full type

{
  id: string,
  name: string,
  created_at: number,
  updated_at: number,
  thumbnail?: {
    width: number,
    height: number,
    url: string
  }
}

listItems

folders.listItems List items in a folder Risk: read

await corsair.canva.api.folders.listItems({});

Input

Name	Type	Required	Description
`folderId`	`string`	Yes	—
`continuation`	`string`	No	—
`limit`	`number`	No	—
`item_types`	`(design \| folder \| image \| brand_template)[]`	No	—
`sort_by`	`created_ascending \| created_descending \| modified_ascending \| modified_descending \| title_ascending \| title_descending`	No	—
`pin_status`	`any \| pinned`	No	—

Output

Name	Type	Required	Description
`items`	`object[]`	Yes	—
`continuation`	`string`	No	—

items full type

(
  {
    type: folder,
    folder: {
      id: string,
      name: string,
      created_at: number,
      updated_at: number,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      }
    }
  } | {
    type: design,
    design: {
      id: string,
      title?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      },
      urls: {
        edit_url: string,
        view_url: string
      },
      created_at: number,
      updated_at: number,
      page_count?: number,
      design_types?: string[],
      owner?: {
        user_id: string,
        team_id: string
      },
      url?: string
    }
  } | {
    type: image,
    image: {
      type: image | video,
      id: string,
      name: string,
      tags: string[],
      created_at: number,
      updated_at: number,
      owner?: {
        user_id: string,
        team_id: string
      },
      thumbnail?: {
        width: number,
        height: number,
        url: string
      }
    }
  } | {
    type: brand_template,
    brand_template: {
      id: string,
      title?: string,
      view_url?: string,
      create_url?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      },
      created_at?: number,
      updated_at?: number
    }
  }
)[]

moveItem

folders.moveItem Move an item to another folder Risk: write

await corsair.canva.api.folders.moveItem({});

Input

Name	Type	Required	Description
`to_folder_id`	`string`	Yes	—
`item_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—

update

folders.update Update a folder name Risk: write

await corsair.canva.api.folders.update({});

Input

Name	Type	Required	Description
`folderId`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`folder`	`object`	Yes	—

folder full type

{
  id: string,
  name: string,
  created_at: number,
  updated_at: number,
  thumbnail?: {
    width: number,
    height: number,
    url: string
  }
}

Imports

create

imports.create Start a job to import a design from binary content Risk: write

await corsair.canva.api.imports.create({});

Input

Name	Type	Required	Description
`title`	`string`	Yes	—
`contentBase64`	`string`	Yes	—
`mime_type`	`string`	No	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    designs: {
      id: string,
      title?: string,
      url?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      }
    }[]
  },
  error?: {
    code: string,
    message: string
  }
}

createFromUrl

imports.createFromUrl Start a job to import a design from a URL Risk: write

await corsair.canva.api.imports.createFromUrl({});

Input

Name	Type	Required	Description
`title`	`string`	Yes	—
`url`	`string`	Yes	—
`mime_type`	`string`	No	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    designs: {
      id: string,
      title?: string,
      url?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      }
    }[]
  },
  error?: {
    code: string,
    message: string
  }
}

get

imports.get Get the status of a design import job Risk: read

await corsair.canva.api.imports.get({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    designs: {
      id: string,
      title?: string,
      url?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      }
    }[]
  },
  error?: {
    code: string,
    message: string
  }
}

getFromUrl

imports.getFromUrl Get the status of a URL design import job Risk: read

await corsair.canva.api.imports.getFromUrl({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    designs: {
      id: string,
      title?: string,
      url?: string,
      thumbnail?: {
        width: number,
        height: number,
        url: string
      }
    }[]
  },
  error?: {
    code: string,
    message: string
  }
}

Resizes

create

resizes.create Start a job to resize a design Risk: write

await corsair.canva.api.resizes.create({});

Input

Name	Type	Required	Description
`design_id`	`string`	Yes	—
`design_type`	`object`	Yes	—

design_type full type

{
  type: preset,
  name: doc | email | presentation | whiteboard
} | {
  type: custom,
  width: number,
  height: number
}

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    design: {
      id: string,
      title?: string,
      owner: {
        user_id: string,
        team_id: string
      },
      thumbnail?: {
        width: number,
        height: number,
        url: string
      },
      urls: {
        edit_url: string,
        view_url: string
      },
      created_at: number,
      updated_at: number,
      page_count?: number,
      design_types?: string[]
    }
  },
  error?: {
    code: string,
    message: string
  }
}

get

resizes.get Get the status of a design resize job Risk: read

await corsair.canva.api.resizes.get({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`job`	`object`	Yes	—

job full type

{
  id: string,
  status: in_progress | success | failed,
  result?: {
    design: {
      id: string,
      title?: string,
      owner: {
        user_id: string,
        team_id: string
      },
      thumbnail?: {
        width: number,
        height: number,
        url: string
      },
      urls: {
        edit_url: string,
        view_url: string
      },
      created_at: number,
      updated_at: number,
      page_count?: number,
      design_types?: string[]
    }
  },
  error?: {
    code: string,
    message: string
  }
}

Users

getCapabilities

users.getCapabilities Get the authenticated user’s capabilities Risk: read

await corsair.canva.api.users.getCapabilities({});

Input: empty object Output

Name	Type	Required	Description
`capabilities`	`string[]`	Yes	—

getMe

users.getMe Get the authenticated user ID and team ID Risk: read

await corsair.canva.api.users.getMe({});

Input: empty object Output

Name	Type	Required	Description
`team_user`	`object`	Yes	—

team_user full type

{
  user_id: string,
  team_id: string
}

getProfile

users.getProfile Get the authenticated user profile Risk: read

await corsair.canva.api.users.getProfile({});

Input: empty object Output

Name	Type	Required	Description
`profile`	`object`	Yes	—

profile full type

{
  display_name?: string
}