Backend API Documentation
Introduction
- Documentation
- Community
- Blog
- Introduction
- GETGet Tenant brand properties
- PUTUpdate Tenant brand properties
- GETGet an Auth Tenant env vars
- POSTRotate Tenant secret key
- GETGet all Tenants
- POSTCreate Tenant
- GETGet Tenant by public key
- GET[tenants.getBySlug] Get Tenant by slug
- GETGet Tenant by id
- PUTUpdate Tenant
- DELDelete Tenant
- GETGet Tenant subscription
- GETGet Tenant members
- DELDelete Tenant member
- PATCHUpdate Tenant member
- POSTInvite Tenant member
- GETGet Tenant invitations
- DELDelete Tenant invitation
- PATCHUpdate Tenant invitation
- GETGet an Tenant
- PUTUpdate an Tenant
- PUTUpdate an Tenant's session settings
- GETGet all Domains
- POSTCreate Domain
- GETGet Domain by id
- DELDelete Domain
- POSTVerify Domain
- POSTSet Domain as primary
- GETGet recent sign ups
- GETGet recent sign ins
- GETGet sign ups by day
- GETGet sessions by day
- GETGet all dashboard stats
- GETGet uploads by day
- GETGet upload size by day
- GETGet all dashboard stats
- GETGet notifications per day
- GETGet all dashboard stats
- GETGet all content dashboard stats
- GETGet all users
- POSTCreate a user
- GETGet a user
- PUTUpdate a user
- DELDelete a user
- PUTChange a user's password
- PUTSuspend a user
- PUTUnsuspend a user
- GETGet all PhoneNumbers for a tenant
- GETGet all User PhoneNumbers
- GETGet a User PhoneNumber
- POSTCreate a User PhoneNumber
- DELDelete an PhoneNumber
- POSTMake an PhoneNumber the primary PhoneNumber for a User
- POSTVerify an PhoneNumber
- GETGet all User EmailAddresses
- GETGet all User EmailAddresses
- GETGet a User EmailAddress
- PUTUpdate a User EmailAddress
- POSTCreate a User EmailAddress
- DELDelete an EmailAddress
- POSTMake an EmailAddress the primary EmailAddress for a User
- POSTVerify an EmailAddress
- GETGet the current user
- GETList all Tenant Invitations for the current user
- POSTAccept a Tenant Invitation
- POSTDecline a Tenant Invitation
- GETGet all organizations
- GETGet an organization
- PUTUpdate an organization
- DELDelete an organization
- POSTCreate an organization
- GETGet all organizationMemberships
- GETGet an organizationMembership
- PUTUpdate an organizationMembership
- DELDelete an organizationMembership
- POSTCreate an organizationMembership
- GETGet all organizationInvitations
- GETGet an organizationInvitation
- PUTUpdate an organizationInvitation
- DELDelete an organizationInvitation
- POSTCreate an organizationInvitation
- GETGet all SocialProviders
- POSTCreate an SocialProvider
- GETGet a SocialProvider's secret
- GETGet an SocialProvider
- PUTUpdate an SocialProvider
- DELDelete a SocialProvider
- GETGet all JWKCertificates
- GETGet all Tenant Uploads
- GETGet a single Upload
- DELDelete a single Upload
- POSTCreate a new Upload
- GETGet all Tenant Transformations
- GETGet a single Transformation
- DELDelete a single Transformation
- PATCHUpdate a single Transformation
- POSTCreate a new Transformation
- GETGet all NotificationTemplates
- GETGet NotificationTemplate by id
- PUTUpdate NotificationTemplate
- DELDelete NotificationTemplate
- POSTCreate NotificationTemplate
- GETGet NotificationTemplate content
- PUTUpdate NotificationTemplate content
- POSTTest NotificationTemplate
- POSTClone all NotificationTemplates to a new tenant
Backend API Documentation
Tenant
Domain
Stats
User
Organization
OrganizationMembership
OrganizationInvitation
SocialProvider
JWKCertificate
Upload
Transformation
NotificationTemplate
Backend API Documentation
Introduction
Example section for showcasing API endpoints
If you’re not looking to build API reference documentation, you can delete this section by removing the api-reference folder.
Welcome
There are two ways to build API documentation: OpenAPI and MDX components. For the starter kit, we are using the following OpenAPI specification.
Backend Endpoints
View the OpenAPI specification file
Authentication
All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
"security": [
{
"bearerAuth": []
}
]