Channel
Get all Channels
Backend API Documentation
Tenant
- 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
Domain
Stats
User
- 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
Organization
OrganizationMembership
OrganizationInvitation
SocialProvider
JWKCertificate
Upload
Transformation
NotificationTemplate
- 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
Notification
Channel
Get all Channels
GET
/
tenants
/
{tenantId}
/
notifications
/
channels
curl --request GET \
--url https://api.pxyz.dev/api/v0/tenants/{tenantId}/notifications/channels
{
"status": "success",
"data": [
{
"id": "<string>",
"tenantId": "<string>",
"name": "<string>",
"key": "<string>",
"description": "<string>",
"type": "email",
"provider": "email_pxyz",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"total": 123,
"count": 123,
"numPages": 123,
"perPage": 123,
"prev": "2023-11-07T05:31:56Z",
"next": "2023-11-07T05:31:56Z"
}
}
Path Parameters
Response
200
application/json
Successful response
Available options:
success
, error
Available options:
email
, sms
, push
, webhook
, inapp
, chat
Available options:
email_pxyz
, email_aws_ses
, email_mailgun
, email_mailjet
, email_mailersend
, email_mailtrap
, email_mandrill
, email_postmark
, email_sendgrid
, email_sparkpost
, email_resend
, inapp_pxyz
, push_firebase
, push_apns
, push_expo
, sms_pxyz
, sms_twilio
, sms_telnyx
, sms_mailersend
, sms_messagebird
, sms_africas_talking
, sms_vonage
, sms_sinch
, sms_aws_sns
, sms_plivo
, chat_slack
, chat_microsoft_teams
, chat_discord
, chat_whatsapp
, webhook
curl --request GET \
--url https://api.pxyz.dev/api/v0/tenants/{tenantId}/notifications/channels
{
"status": "success",
"data": [
{
"id": "<string>",
"tenantId": "<string>",
"name": "<string>",
"key": "<string>",
"description": "<string>",
"type": "email",
"provider": "email_pxyz",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"total": 123,
"count": 123,
"numPages": 123,
"perPage": 123,
"prev": "2023-11-07T05:31:56Z",
"next": "2023-11-07T05:31:56Z"
}
}