Platform API
Access stemp platform services like email from your installed app.
Platform API
The Platform API gives installed apps access to stemp infrastructure services. Unlike the standard API (which manages your own resources), the Platform API lets your app leverage stemp's built-in capabilities to deliver a richer experience to the organizations that install it.
Available Services
| Service | Scope | Description |
|---|---|---|
platform:email:send | Send transactional and marketing emails to users and members |
Authentication
Platform API endpoints are only available to installed apps using OAuth2 app installation tokens. They cannot be accessed with API tokens or user sessions.
Authorization: Bearer <app_installation_access_token>See the OAuth2 Flow guide for how to obtain an installation access token.
Platform Scopes
Platform scopes are separate from standard API scopes and must be requested during app installation. They are prefixed with platform:.
| Scope | Description |
|---|---|
platform:email:send | Send emails via the stemp email infrastructure and view email logs |
These scopes appear on the consent screen when an organization installs your app. Request only the platform scopes your app needs.
How It Works
- Your app requests platform scopes (e.g.,
platform:email:send) during the OAuth2 authorization flow. - The organization grants consent on the install screen.
- Your app uses the installation access token to call Platform API endpoints.
- stemp handles the infrastructure (email delivery, unsubscribe management, etc.) on behalf of the organization.
Sender Identity
When your app sends emails through the Platform API, they are sent from the organization's branded address:
From: {Organization Name} <{org-slug}@stemp.email>This means recipients see the organization's name, not your app's name — providing a seamless experience.