Platform API

This is the same REST API the SimpliSend dashboard itself calls - every screen in the app is built on these endpoints. It's authenticated with a Bearer JWT, not an API key, and most of it requires the caller to belong to an account with a specific permission.

Most third-party integrations only need the Public API. Reach for this surface if you specifically need account-management capabilities it doesn't cover - managing contacts, campaigns, billing, or team members programmatically.

Reference by resource

Conventions

  • All list/create/update/delete endpoints require an account-scoped permission - see each resource page.
  • Anything under /admin/* requires the calling user to be a platform admin, not just an account Owner.
  • Dynamic route params (:id) are resolved from the URL path, not the request body.
  • Errors follow the same envelope across both API surfaces - see Errors.