Skip navigation

Skip to main content

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload Changelog

Design

addAudioTrack addElementAtCursor addElementAtPoint addPage bulkCreate.launch createRichtextRange editContent

getCurrentPageContext getDesignMetadata

getDesignTemplateMetadata

getDesignToken initAppElement openDesign

overlay.registerOnCanOpen publish.launch requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint

Intents

Intents: Asset

prepareUrlExpander

Intents: Content

prepareContentPublisher

Intents: data

prepareDataConnector

Intents: design

prepareDesignEditor

Platform

appProcess appProcess.broadcastMessage appProcess.current appProcess.current.getInfo appProcess.current.requestClose appProcess.current.setOnDispose appProcess.requestClose appProcess.registerOnMessage appProcess.registerOnStateChange features.isSupported features.registerOnSupportChange getPlatformInfo notification.addToast requestOpenExternalUrl

User

auth.getCanvaUserToken auth.initOauth

App middleware

initUserTokenVerifier

initDesignTokenVerifier

TokenVerificationError

App middleware: Express

tokenExtractors

user.verifyToken

design.verifyToken

PageRef

API reference for the PageRef type.

This API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

A reference to a page.

Type declaration

A reference to an absolute type page.

typestringRead-only

Required

The type of page.

The only valid value is "absolute".

lockedbooleanRead-only

Required

If true, the page is locked and cannot be modified.

Represents something that's not supported by the Apps SDK.

typestringRead-only

Required

The only valid value is "unsupported".