Skip to main content
POST
Resolve Share Link

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Body

application/json
url
string
required

Share URL or bare share token (e.g. https://moda.app/s/<token> or <token>).

Response

Successful Response

canvas_id
string
required

Prefixed canvas ID the share link points to.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

canvas_name
string
required

Display name of the shared canvas.

permission
enum<string>
required

Permission level granted by the share link.

Available options:
view,
view_remix
share_token
string
required

The share token extracted from the URL (opaque; treat as the identifier).