Connect

Mint connect link

Mint a short-lived link to the hosted connect/manage page. Pass profile to scope the page to one tenant. Pass returnUrl to send the browser back to your app with connect_status after OAuth (the Upload-Post / Ayrshare JWT pattern). Pass platforms to show only those networks. Do not give end users POST /v1/app-link; that mints a 12-hour dashboard session.

post/v1/connect-link

Request

  • Base URL: https://api.postlake.dev
  • URL: https://api.postlake.dev/v1/connect-link
  • Auth: bearerAuth (a scheme the document does not define)

Request body

profilestring

Scope the hosted page and the new connection to this profile username. Required for tenant-safe handoffs; workspace API keys still access all profiles.

returnUrlstring uri

https callback URL without credentials or a fragment. http is allowed only for localhost. Outcome query parameters are unsigned display hints. Bind an expiring single-use state to your signed-in customer on your backend, then read their stored profile's accounts. Never authorize a tenant using the returned profile parameter.

platformsstring[]

Optional non-empty allow-list enforced on connection and disconnection routes, not just page visibility. Omit for all available networks.

Response

Success

urlstring uri required
expiresInSecondsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.