Docs menu · Authentication & endpoints

API reference

Authentication & endpoints

Plain HTTP with a Bearer key. No SDK.

Authentication

Create a key under Settings → Workspace → API keys and pick All or Read-only. Send it on every request:

curl https://www.bridgly.co/api/v1/stats/summary \
  -H "Authorization: Bearer <your API key>"

Keys belong to the workspace, so one key reaches every link, partner and payout in it. Calls that act on a single link (POST /api/v1/links, /api/track/*) take an optional projectId. If you leave it out, Bridgly uses the workspace's only link, or returns 400 asking for one if there are several.

Responses

  • **/api/v1/*:** { "data": … } on success, { "error": "…" } on failure.
  • **/api/track/*:** { "ok": true, … } on success. A retried sale with the same invoiceId returns duplicate: true.

Rate limit

120 requests per minute per workspace, shared across /api/v1/* and /api/track/*. Over the limit returns 429 with a Retry-After header in seconds.

Errors

StatusMeaning
400Invalid request
401Missing, invalid or revoked key
403Not allowed (for example, a read-only key writing, or a self-referral)
404Not found in this workspace
429Rate limited; honour Retry-After

Machine-readable

Endpoints

Generated from /openapi.json.

Stats

  • GET/api/v1/stats/summaryProject click/lead/sale summary
  • GET/api/v1/stats/funnelWorkspace conversion funnel

Links

  • GET/api/v1/linksList short links for the key’s project
  • POST/api/v1/linksCreate a short link on the key’s project

Payouts

  • GET/api/v1/payouts/summaryWorkspace partner payout balances

Conversions

  • GET/api/v1/conversionsRecent project conversions

Partners

  • GET/api/v1/partnersList partners (referrers) for the key’s workspace
  • GET/api/v1/partners/{id}/statsPartner-level clicks, leads, sales

Track

  • POST/api/track/leadTrack a lead conversion
  • POST/api/track/saleTrack a sale conversion

Stuck? Contact us and a person will reply.