Redirect URL

API reference for the "Redirect URL" endpoint.

When a user attempts to authenticate with an app, Canva begins the authentication flow by opening a pop-up window. This window:

  • Redirects users to the app's Redirect URL.

  • Appends query parameters to the Redirect URL.

You can configure an app's Redirect URL via the Developer Portal.

The query parameters include the user's ID, which the app can use to authenticate the user.

To learn more, refer to Authentication.

Request

Endpoint

GET <redirect_url>

Query

Properties

Property

Type

Required

Description

brand

string

Yes

The ID of the user's team.

extensions

string

Yes

The extension points the user is attempting to authenticate with.

signatures

string

Yes

A comma-separated list of request signatures.

state

string

Yes

A token the app must return to Canva at the end of the authentication flow.

time

string

Yes

The UNIX timestamp (in seconds) of when the user started the authentication flow.

user

string

Yes

The ID of the user.

Example

<redirect_url>?brand=<brand>&extensions=<extensions>&signatures=<signatures>&state=<state>&time=<time>&user=<user>