API Reference
Log In
API Reference

Basic Tenant Pathway

Steps

1. Sign up

Sign up for a Tenant Account.

POST /dbconnections/signup HTTP/1.1


2. Login

POST /oauth/token HTTP/1.1


3. Create Account

POST /api/v1/users/accounts


4. Login again


5. Get Account by ID

GET /api/v1/users/accounts/account-id/{accountId}


6. Create Customer

POST /api/v1/subscriptions/customers


7. Create payment methods

POST /api/v1/subscriptions/customers/customer-id/{customerId}/payment-methods


8. Create Tenant

POST /api/v1/tenants/tenant


9. Login again


10. Create Subscription

CREATE /api/v1/tenants/tenant/tenant-id/{tenantId}/subscriptions


11. Get licenses

GET /api/v1/tenants/tenant/tenant-id/{tenantId}/subscriptions/subscription-id/{subscriptionId}/licenses


12. Assign licenses

POST /api/v1/tenants/tenant/tenant-id/{tenantId}/subscriptions/subscription-id/{subscriptionId}/licenses


13. Get brandings

GET /api/v1/tenants/tenant/tenant-id/{tenantId}/branding


14. Get flavors

GET /api/v1/tenants/tenant/tenant-id/{tenantId}/branding/brand-id/{brandId}/flavors


15. Update flavors

PUT /api/v1/tenants/tenant/tenant-id/{tenantId}/branding/brand-id/{brandId}/flavors/flavor-id/{flavorId}


16. Sync Messages

/api/v1/tenants/tenant/tenant-id/{tenantId}/messages/sync


17. Create Drawer default

POST /api/v1/tenants/tenant/tenant-id/{tenantId}/subscriptions/subscription-id/{subscriptionId}/sidedrawer


18. Get available licenses again


19. Create Drawer support

POST /api/v1/tenants/tenant/tenant-id/{tenantId}/subscriptions/subscription-id/{subscriptionId}/sidedrawer


20. Create Webhook subscription

POST /api/v1/developers/tenant/tenant-id/{tenantId}/webhooks?connectionType=HTTP


21. Create Folder

POST /api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records


22. Create file

POST /api/v1/record-files/sidedrawer/sidedrawer-id/{sidedrawerId}/records/record-id/{recordId}/record-files?fileName=pdfFile&uploadTitle=pdfFile&fileType=document