v1

latestOpenAPI 3.1.02026-07-223261135.0 KB

share-links

Resolve Share Link

Resolve a share URL to its canvas_id and share metadata.

Distinguishes share_link_revoked (the share row exists but is disabled) from share_link_not_found (no live row — includes never-existed, soft-deleted, and deleted-canvas cases; we don't leak which). Share tokens are shareable by design — surfacing revocation state for active rows is intentional.

post/share_links/resolve

Headers

Moda-Version'2026-04-12' | '2026-05-01'

Example: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.

Request body

urlstring required

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

Response

Successful Response

canvas_idstring required

Prefixed canvas ID the share link points to.

canvas_namestring required

Display name of the shared canvas.

permission'view' | 'view_remix' required

Permission level granted by the share link.

share_tokenstring required

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

Example response

{
  "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
}