Canva API

Canva endpoints in the Brix REST API: 8 operations (GET, POST, DELETE). Each lists its path, auth, required permission and a curl example.

View as Markdown · For AI agents: the full docs index is at /llms.txt

Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says Auth: none or Auth: no API key. The Permission line names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.

Every 4xx and 5xx response below returns this body:

FieldTypeDescription
errorstringMachine-readable code: unauthorized, forbidden, not_found, validation_error, conflict, rate_limited, internal_error, …
messagestringHuman-readable explanation. Safe to show an operator.
requestIdstringPresent on 5xx: quote it to support.

GET /v1/canva/connections/{id}/designs

Auth: Bearer token.

List the designs in a connected Canva account, with search and paging. Thumbnails are links that expire after 15 minutes. The answer also tells which designs this workspace follows.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl "https://api.brixsignage.com/v1/canva/connections/{id}/designs" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/canva/connections/{id}/designs/{designId}/editable

Auth: Bearer token.

Start an export of every page of a Canva design as a PowerPoint file, to make a design with layers. Nothing is followed. Get the file with the export operation.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
designIdpathstringyesIdentifier for designId.
curl -X POST "https://api.brixsignage.com/v1/canva/connections/{id}/designs/{designId}/editable" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

GET /v1/canva/connections/{id}/exports/{jobId}/pptx

Auth: Bearer token.

Get the PowerPoint file of an editable copy export. The answer is 202 while Canva still makes the file, then the file itself.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
jobIdpathstringyesIdentifier for jobId.
curl "https://api.brixsignage.com/v1/canva/connections/{id}/exports/{jobId}/pptx" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/canva/connections/{id}/import

Auth: Bearer token.

Follow up to 20 Canva designs into a folder as a video, a picture or pages. The first export starts at once. A followed design updates when it changes in Canva.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl -X POST "https://api.brixsignage.com/v1/canva/connections/{id}/import" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

GET /v1/canva/designs

Auth: Bearer token.

List the Canva designs this workspace follows, with the folder, the account, the state of the last export and a link to open the design in Canva.

curl "https://api.brixsignage.com/v1/canva/designs" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

DELETE /v1/canva/designs/{id}

Auth: Bearer token.

Stop following a Canva design. The imported file stays in the media library.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl -X DELETE "https://api.brixsignage.com/v1/canva/designs/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/canva/designs/{id}/refresh

Auth: Bearer token.

Read the design from Canva and export it now. The file is replaced in place. A long export finishes in the next few minutes.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl -X POST "https://api.brixsignage.com/v1/canva/designs/{id}/refresh" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

GET /v1/canva/status

Auth: Bearer token.

Tell if Import from Canva is available in this workspace.

curl "https://api.brixsignage.com/v1/canva/status" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.