API reference

Everything the dashboard does, you can do over the REST API — with scoped API keys (Settings) or the typed @canvasrelay/api-client package. Machine-readable spec: GET /api/v1/openapi.json on the API origin.

Authenticating

Create a scoped key under Settings → API keys and send it as a Bearer token. Keys are shown once (only the hash is stored) and can carry read/write scopes per resource — mint the narrowest key that does the job.

curl https://api.canvasrelay.app/api/v1/boards \
  -H "Authorization: Bearer crk_…"

Errors come back as a JSON envelope with a stable CR-xxxx code, a message, and an HTTP status. Rate limits are per-IP for anonymous routes and per-workspace for authed ones (CR-1006, 429).

The public board feed — what players poll — needs no auth: GET /api/v1/feed/{board-slug} with ETag revalidation.

auth

POST/api/v1/auth/signupauth signup

POST/api/v1/auth/verify-emailauth verify email

POST/api/v1/auth/loginauth login

POST/api/v1/auth/logoutauth logout

POST/api/v1/auth/password/forgotauth password forgot

POST/api/v1/auth/password/resetauth password reset

POST/api/v1/auth/password/changeauth password change

GET/api/v1/auth/meauth me

GET/api/v1/auth/sessionsauth sessions list

DELETE/api/v1/auth/sessions/{id}auth session delete

GET/api/v1/auth/oauth/googleauth o auth google start

GET/api/v1/auth/oauth/google/callbackauth o auth google callback

DELETE/api/v1/auth/oauth/googleauth o auth google disconnect

DELETE/api/v1/auth/accountauth account delete

orgs

GET/api/v1/orgsorgs list

POST/api/v1/orgsorgs create

GET/api/v1/orgs/currentorgs current

PATCH/api/v1/orgs/currentorgs patch

GET/api/v1/orgs/{orgId}/exportorg export request

GET/api/v1/orgs/{orgId}/export/{jobId}org export job

GET/api/v1/export/jobs/{jobId}/downloadexport job download

GET/api/v1/export/media/{mediaId}export media fetch

POST/api/v1/orgs/{orgId}/deletionorg deletion schedule

DELETE/api/v1/orgs/{orgId}/deletionorg deletion cancel

GET/api/v1/orgs/{orgId}/membersorg members list

PATCH/api/v1/orgs/{orgId}/members/{userId}org member patch

DELETE/api/v1/orgs/{orgId}/members/{userId}org member delete

GET/api/v1/orgs/{orgId}/invitationsorg invitations list

POST/api/v1/orgs/{orgId}/invitationsorg invitations create

POST/api/v1/orgs/{orgId}/invitations/{invitationId}/resendorg invitation resend

DELETE/api/v1/orgs/{orgId}/invitations/{invitationId}org invitation delete

POST/api/v1/invitations/acceptinvitation accept

GET/api/v1/invitations/{token}invitation peek

billing

GET/api/v1/billing/entitlementsbilling entitlements

POST/api/v1/billing/checkoutbilling checkout

POST/api/v1/billing/subscriptionbilling subscription

POST/api/v1/billing/credits/checkoutbilling credits checkout

POST/api/v1/billing/credits/claimbilling credits claim

POST/api/v1/billing/portalbilling portal

POST/api/v1/billing/webhookbilling webhook

boards

GET/api/v1/boardsboards list

POST/api/v1/boardsboards create

GET/api/v1/boards/{id}boards get

PATCH/api/v1/boards/{id}boards patch

DELETE/api/v1/boards/{id}boards delete

POST/api/v1/boards/{id}/publishboards publish

GET/api/v1/boards/{id}/releasesboard releases list

GET/api/v1/boards/{id}/playbackboard playback

POST/api/v1/boards/{id}/rollbackboards rollback

POST/api/v1/boards/{id}/duplicateboards duplicate

POST/api/v1/boards/{id}/test-sessionboards test session

GET/api/v1/boards/{boardId}/menusboard menus list

GET/api/v1/boards/{boardId}/scenesboard scenes list

POST/api/v1/boards/{boardId}/scenes/reorderboard scenes reorder

GET/api/v1/boards/{boardId}/schedulesboard schedules list

GET/api/v1/boards/{boardId}/takeoversboard takeovers list

menus

POST/api/v1/menusmenus create

GET/api/v1/menus/{id}menus get

PATCH/api/v1/menus/{id}menus patch

DELETE/api/v1/menus/{id}menus delete

POST/api/v1/menus/{id}/importmenus import

POST/api/v1/menu/sectionssections create

PATCH/api/v1/menu/sections/{id}sections patch

DELETE/api/v1/menu/sections/{id}sections delete

POST/api/v1/menu/itemsitems create

PATCH/api/v1/menu/items/{id}items patch

DELETE/api/v1/menu/items/{id}items delete

POST/api/v1/menu/items/{id}/sold-outitems sold out

PATCH/api/v1/menu/pricesmenu prices bulk

scenes

POST/api/v1/scenesscenes create

GET/api/v1/scenes/{id}scenes get

PATCH/api/v1/scenes/{id}scenes patch

DELETE/api/v1/scenes/{id}scenes delete

GET/api/v1/scenes/{id}/elementsscene elements list

PUT/api/v1/scenes/{id}/elementsscene elements put

GET/api/v1/scenes/{id}/draftscene draft get

PUT/api/v1/scenes/{id}/draftscene draft put

schedules

POST/api/v1/schedulesschedules create

PUT/api/v1/schedules/{id}schedules replace

POST/api/v1/schedules/{id}/activateschedules activate

DELETE/api/v1/schedules/{id}schedules delete

media

GET/api/v1/mediamedia list

POST/api/v1/mediamedia create

PATCH/api/v1/media/{id}media patch

DELETE/api/v1/media/{id}media delete

PUT/api/v1/media/{id}/blobmedia blob put

GET/api/v1/media/{id}/blobmedia blob get

GET/api/v1/media/{id}/accessmedia access

GET/api/v1/media/{id}/usagemedia usage

POST/api/v1/media/tagsmedia tags

fonts

GET/api/v1/fontsfonts list

POST/api/v1/fontsfonts create

DELETE/api/v1/fonts/{id}fonts delete

templates

GET/api/v1/templatestemplates list

GET/api/v1/templates/{id}templates get

POST/api/v1/templatestemplates create

DELETE/api/v1/templates/{id}templates delete

takeovers

GET/api/v1/takeoverstakeovers list

POST/api/v1/takeoverstakeovers create

DELETE/api/v1/takeovers/{id}takeovers delete

devices

DELETE/api/v1/devices/selfdevice self delete

GET/api/v1/devices/self/boardsdevice self boards

POST/api/v1/devices/self/boarddevice self board

GET/api/v1/devicesdevices list

GET/api/v1/devices/{id}devices get

PATCH/api/v1/devices/{id}devices patch

DELETE/api/v1/devices/{id}devices delete

DELETE/api/v1/devices/{id}/purgedevices purge

POST/api/v1/devices/{id}/screenshotsdevice screenshots create

GET/api/v1/devices/{id}/screenshots/{screenshotId}/blobdevice screenshot blob

PUT/api/v1/devices/screenshots/{id}/blobdevice screenshot upload

POST/api/v1/devices/{id}/commandsdevice commands create

GET/api/v1/devices/{id}/commandsdevice commands list

POST/api/v1/devices/{id}/releasedevice release pin

GET/api/v1/devices/{id}/renderdevice render

POST/api/v1/devices/pair/startdevice pair start

POST/api/v1/devices/pair/claimdevice pair claim

GET/api/v1/devices/pair/polldevice pair poll

POST/api/v1/devices/heartbeatdevice heartbeat

POST/api/v1/devices/playbackdevice playback

POST/api/v1/devices/tokendevice token

POST/api/v1/devices/commands/{id}/ackdevice command ack

feed

GET/api/v1/feed/{slug}feed get

assist

POST/api/v1/assist/layoutassist layout

POST/api/v1/assist/general-screenassist general screen

POST/api/v1/assist/copyassist copy

POST/api/v1/assist/bulkassist bulk

POST/api/v1/assist/import-menuassist import menu

POST/api/v1/assist/menu-planassist menu plan

POST/api/v1/assist/imageassist image

POST/api/v1/assist/image-editassist image edit

POST/api/v1/assist/slideshowassist slideshow

POST/api/v1/assist/slideshow/{id}/acceptassist slideshow accept

POST/api/v1/assist/scene-editassist scene edit

GET/api/v1/assist/creditsassist credits

POST/api/v1/assist/import-menu/{id}/acceptassist import menu accept

ai

GET/api/v1/ai/jobsai jobs list

GET/api/v1/ai/jobs/{id}ai jobs get

GET/api/v1/ai/consentai consent get

POST/api/v1/ai/consentai consent accept

DELETE/api/v1/ai/consentai consent withdraw

GET/api/v1/ai/reportsai reports list

POST/api/v1/ai/reportsai reports create

proposals

GET/api/v1/proposalsproposals list

POST/api/v1/proposalsproposals create

POST/api/v1/proposals/{id}/applyproposals apply

POST/api/v1/proposals/{id}/approveproposals approve

POST/api/v1/proposals/{id}/rejectproposals reject

keys

GET/api/v1/keyskeys list

POST/api/v1/keyskeys create

DELETE/api/v1/keys/{id}keys delete

events

GET/api/v1/eventsevents list

email

GET/api/v1/email/unsubscribeemail unsubscribe

test session

GET/api/v1/test-session/{token}test session resolve

tools

POST/api/v1/tools/menu-photo-previewtools menu photo preview

health

GET/api/v1/healthhealth

networks

GET/api/v1/networksnetworks list

POST/api/v1/networksnetworks create

GET/api/v1/networks/{networkId}network get

PATCH/api/v1/networks/{networkId}network patch

GET/api/v1/networks/{networkId}/overviewnetwork overview

GET/api/v1/networks/{networkId}/organizationsnetwork organizations list

POST/api/v1/networks/{networkId}/organizationsnetwork organizations link

PATCH/api/v1/networks/{networkId}/organizations/{organizationId}network organization patch

DELETE/api/v1/networks/{networkId}/organizations/{organizationId}network organization delete

GET/api/v1/networks/{networkId}/screensnetwork screens list

GET/api/v1/networks/{networkId}/operatorsnetwork operators list

POST/api/v1/networks/{networkId}/operatorsnetwork operators create

PATCH/api/v1/networks/{networkId}/operators/{userId}network operator patch

GET/api/v1/networks/{networkId}/brandingnetwork branding get

PUT/api/v1/networks/{networkId}/brandingnetwork branding put

GET/api/v1/networks/{networkId}/hostnamesnetwork hostnames list

POST/api/v1/networks/{networkId}/hostnamesnetwork hostnames create

GET/api/v1/networks/{networkId}/delegated-sessionsnetwork delegated sessions list

POST/api/v1/networks/{networkId}/delegated-sessionsnetwork delegated sessions create

DELETE/api/v1/networks/{networkId}/delegated-sessions/{sessionId}network delegated session delete

GET/api/v1/networks/{networkId}/eventsnetwork events list

GET/api/v1/networks/{networkId}/templatesnetwork templates list

POST/api/v1/networks/{networkId}/templatesnetwork templates create

GET/api/v1/networks/{networkId}/templates/{templateId}/versionsnetwork template versions list

POST/api/v1/networks/{networkId}/templates/{templateId}/versionsnetwork template versions create

PATCH/api/v1/networks/{networkId}/templates/{templateId}/versions/{versionId}network template version patch

GET/api/v1/networks/{networkId}/campaignsnetwork campaigns list

POST/api/v1/networks/{networkId}/campaignsnetwork campaigns create

PATCH/api/v1/networks/{networkId}/campaigns/{campaignId}network campaign patch

POST/api/v1/networks/{networkId}/campaigns/{campaignId}/materializenetwork campaign materialize

GET/api/v1/networks/{networkId}/campaigns/{campaignId}/deploymentsnetwork campaign deployments list

POST/api/v1/networks/{networkId}/campaigns/{campaignId}/withdrawnetwork campaign withdraw

POST/api/v1/networks/{networkId}/campaigns/{campaignId}/deployments/{deploymentId}/rollbacknetwork campaign deployment rollback

GET/api/v1/networks/{networkId}/campaigns/{campaignId}/proofnetwork campaign proof

network campaigns

GET/api/v1/network-campaignsorg network campaigns list

PATCH/api/v1/network-campaigns/{deploymentId}/overridesorg network campaign overrides

POST/api/v1/network-campaigns/{deploymentId}/installorg network campaign install

POST/api/v1/network-campaigns/{deploymentId}/declineorg network campaign decline

portal

GET/api/v1/portal/configportal config

notifications

GET/api/v1/notifications/preferencesnotification preferences get

PUT/api/v1/notifications/preferencesnotification preferences put

GET/api/v1/notifications/inboxnotification inbox list

PATCH/api/v1/notifications/inbox/{id}notification inbox patch

POST/api/v1/notifications/testnotification test

mobile

GET/api/v1/mobile/push/subscriptionsmobile push subscriptions list

POST/api/v1/mobile/push/subscriptionsmobile push subscriptions create

DELETE/api/v1/mobile/push/subscriptionsmobile push subscriptions delete

POST/api/v1/mobile/push/publish-failuremobile push publish failure

pi

POST/api/v1/pi/auth/loginpi auth login

POST/api/v1/pi/auth/logoutpi auth logout

POST/api/v1/pi/auth/select-orgpi auth select org

GET/api/v1/pi/sessionpi session

POST/api/v1/pi/device/registerpi device register

relay

GET/api/v1/relay/{slug}relay get

integrations

GET/api/v1/integrations/googlegoogle integrations get

POST/api/v1/integrations/google/{product}/connectgoogle integration connect

GET/api/v1/integrations/google/callbackgoogle integration callback

GET/api/v1/integrations/google/calendar/calendarsgoogle integration calendars

GET/api/v1/integrations/google/business-profile/locationsgoogle integration business locations

DELETE/api/v1/integrations/google/{product}google integration delete

GET/api/v1/integrations/http-connectorshttp connectors list

POST/api/v1/integrations/http-connectorshttp connectors create

PATCH/api/v1/integrations/http-connectors/{id}http connectors patch

DELETE/api/v1/integrations/http-connectors/{id}http connectors delete

POST/api/v1/integrations/http-connectors/{id}/testhttp connectors test

GET/api/v1/integrations/openligadb/leaguesopen liga leagues

device board-schedules

GET/api/v1/device-board-schedulesdevice board schedules list

POST/api/v1/device-board-schedulesdevice board schedules create

PUT/api/v1/device-board-schedules/{id}device board schedules replace

DELETE/api/v1/device-board-schedules/{id}device board schedules delete

device board-schedule-pauses

PUT/api/v1/device-board-schedule-pausesdevice board schedule pause

releases

POST/api/v1/releases/{id}/assignrelease assign

webhooks

GET/api/v1/webhookswebhooks list

POST/api/v1/webhookswebhooks create

DELETE/api/v1/webhooks/{id}webhooks delete

POST/api/v1/webhooks/{id}/testwebhooks test

brand kit

GET/api/v1/brand-kitbrand kit get

PUT/api/v1/brand-kitbrand kit put

openapi.json

GET/api/v1/openapi.jsonopenapi get

support

POST/api/v1/support/asksupport ask

roku

POST/api/v1/roku/auth/loginroku auth login

POST/api/v1/roku/auth/signuproku auth signup

POST/api/v1/roku/auth/select-orgroku auth select org

GET/api/v1/roku/sessionroku session

POST/api/v1/roku/auth/logoutroku auth logout

POST/api/v1/roku/device/registerroku device register

GET/api/v1/roku/catalogroku catalog

POST/api/v1/roku/purchases/validateroku purchases validate

POST/api/v1/roku/pay/pushroku pay push