Docs

Changelog

Versioned release notes for the Tendral Partners API. Backward-incompatible changes are flagged 'Breaking' and announced ≥30 days in advance via your registered partner contact.

Subscribe to changes via RSS at /docs/changelog/feed.xml. Major versions of the API live on independent base paths (/v1/, future /v2/); within a major version, changes are additive.

v1.0

Partners

Initial Partners API for Stitched Health — 4 GET endpoints, Stripe-style envelope, multi-sig HMAC webhooks, scoped bearer tokens.

  • GET /v1/partners/stitched/tokens — list recipient records with composite cursor pagination
  • GET /v1/partners/stitched/tokens/{token} — single-token resolve with ETag/304 support
  • GET /v1/partners/stitched/events — list outreach events (email_sent, email_bounced) with type filter
  • GET /v1/partners/stitched/campaigns/{id}/recipients — list recipients for a campaign
  • Stripe-style multi-sig HMAC webhooks (X-Signature: t=,v1=) with 5-minute drift tolerance and zero-downtime rotation
  • Per-resource scopes: tokens:read, events:read, recipients:read
  • expand[]=campaign|program|recipient parameters where applicable
  • Idempotency-Key support on POST endpoints (forward-compat; no POSTs in v1)
  • 100 requests/minute rate limit per API key with X-RateLimit-* headers
  • Stripe-style error envelope with type, code, doc_url, request_id
  • Full developer docs at developer.tendralhealth.com