{"id":21,"date":"2026-08-28T13:48:31","date_gmt":"2026-08-28T13:48:31","guid":{"rendered":"https:\/\/demos.canvaswp.com\/link-in-bio\/api-docs\/"},"modified":"2026-08-28T13:48:31","modified_gmt":"2026-08-28T13:48:31","slug":"api-docs","status":"publish","type":"page","link":"https:\/\/demos.canvaswp.com\/link-in-bio\/api-docs\/","title":{"rendered":"API Docs"},"content":{"rendered":"<section class=\"section cp-section\"><div class=\"container\"><div class=\"row g-5\"><div class=\"col-lg-5\"><h2 class=\"cp-headline\" style=\"font-size:2rem\">Authenticate once<\/h2><p class=\"cp-lead\">Create a token in your dashboard and send it as a bearer token. Tokens are scoped per page and can be revoked at any time.<\/p><\/div><div class=\"col-lg-6 offset-lg-1\"><div class=\"cp-code\"><span class=\"cp-code-verb\">GET<\/span> https:\/\/api.canvaspulse.example\/v1\/pages\/mayalin<br>Authorization: Bearer cnp_live_&#8230;<br>Accept: application\/json<\/div><\/div><\/div><\/div><\/section><section style=\"background:#F7F5FF\" class=\"section cp-section\"><div class=\"container\"><div class=\"row justify-content-center text-center mb-5\"><div class=\"col-lg-7\"><span class=\"cp-eyebrow\">Endpoints<\/span><h2 class=\"cp-headline\">Six endpoints cover the page<\/h2><p class=\"cp-lead mx-auto\">Everything a page is made of is readable and writable. Rate limits are per token, not per page.<\/p><\/div><\/div><div class=\"cp-status-row\"><span style=\"font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:0.85rem\">GET \/v1\/pages\/{handle}<\/span><span style=\"margin-left:auto; font-size:0.82rem; color:var(--pulse-muted); text-align:right\">Read a public page: its theme, its blocks and its link order.<\/span><\/div><div class=\"cp-status-row\"><span style=\"font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:0.85rem\">POST \/v1\/links<\/span><span style=\"margin-left:auto; font-size:0.82rem; color:var(--pulse-muted); text-align:right\">Add a link block to a page. Accepts a title, a URL, a schedule and a group.<\/span><\/div><div class=\"cp-status-row\"><span style=\"font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:0.85rem\">PATCH \/v1\/links\/{id}<\/span><span style=\"margin-left:auto; font-size:0.82rem; color:var(--pulse-muted); text-align:right\">Update a link block, including its position and its schedule.<\/span><\/div><div class=\"cp-status-row\"><span style=\"font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:0.85rem\">GET \/v1\/analytics\/clicks<\/span><span style=\"margin-left:auto; font-size:0.82rem; color:var(--pulse-muted); text-align:right\">Click totals per link for a date range, with traffic source and country.<\/span><\/div><div class=\"cp-status-row\"><span style=\"font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:0.85rem\">POST \/v1\/subscribers<\/span><span style=\"margin-left:auto; font-size:0.82rem; color:var(--pulse-muted); text-align:right\">Add an email subscriber captured outside the page.<\/span><\/div><div class=\"cp-status-row\"><span style=\"font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:0.85rem\">GET \/v1\/products<\/span><span style=\"margin-left:auto; font-size:0.82rem; color:var(--pulse-muted); text-align:right\">List the products on a store tab, with prices and stock.<\/span><\/div><\/div><\/section>","protected":false},"excerpt":{"rendered":"<p>The CanvasPulse REST API: read a page, add links, pull analytics and manage store products.<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"page-canvas","meta":{"footnotes":""},"class_list":["post-21","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/demos.canvaswp.com\/link-in-bio\/wp-json\/wp\/v2\/pages\/21","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/demos.canvaswp.com\/link-in-bio\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/demos.canvaswp.com\/link-in-bio\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/demos.canvaswp.com\/link-in-bio\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/demos.canvaswp.com\/link-in-bio\/wp-json\/wp\/v2\/comments?post=21"}],"version-history":[{"count":0,"href":"https:\/\/demos.canvaswp.com\/link-in-bio\/wp-json\/wp\/v2\/pages\/21\/revisions"}],"wp:attachment":[{"href":"https:\/\/demos.canvaswp.com\/link-in-bio\/wp-json\/wp\/v2\/media?parent=21"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}