Documentation
Version
Platform Dashboard GuideREST API ReferenceMCP Server for AI AgentsBuilding ConnectorsWebhooks & EventsAutomations & Integrations

Distribution API

Every project exposes two public URLs: the subscriber portal and the deep link into the project's connector installation, with a start payload that decides what opens.

Every project exposes two public URLs: the subscriber portal and the deep link into the project's connector installation, with a start payload that decides what opens. These endpoints return the canonical strings so clients do not reconstruct them from project, installation and plan fields themselves; if the URL shapes ever change, REST callers get the update for free. The connector shapes its own links; nothing here spells a platform's URL.

Endpoints

GET/v1/projects/{project}/distribution/deep-linkBuild a deep linkGET/v1/projects/{project}/distribution/portal-urlGet the portal URL

Related

Connectors APIRead the installation's state before building deep links; the installation object carries its handle.Projects APIhandle on the project resource.Share Your ProjectPut your project in front of subscribers through your bot link, the hosted portal page, QR codes and embedded buttons.

How is this guide?

Last updated on

Switch to the backup account

/v1/me/recovery/backup-identity/switch in the Disaster Recovery API.

Build a deep link

/v1/projects/{project}/distribution/deep-link in the Distribution API.

Version

On this page

Endpoints

Subscriby is a product
designed by you — for you.No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request

For AI agents: llms.txt · llms-full.txt