MSAAQ Documentation
Docs
APIs
  • Admin
  • Tenant
Docs
APIs
  • Admin
  • Tenant
Status
  1. Tenant
  • Getting Started
  • Integration Guides
    • Google Tag Manager (GTM)
  • APIs
    • OAuth
      • Ping
      • Craete Token
      • Craete Token - From Accounts
    • Admin
      • Auth
        • Register
        • Login
        • Me
        • Logout
        • change-password
        • change-email
        • update
        • permissions
        • Email verification
        • Refresh Token
        • accept Invitation
        • Reset Password
        • Forget Password
        • Passwordless
        • Phone Verification
      • Teams
        • Users
          • Send reset password email
          • Send verification email
          • Delete User
          • Update User
          • instructors
          • list
          • Craete User
        • Permissions
          • list
        • Roles
          • Get Role Permissions
          • Delete Role
          • Update Role
          • Get Role
          • Create
          • list
      • Academies
        • Join Beta
        • Create
        • list
      • Dashboards
        • Main
          • Sales By Country
          • Best sales
          • Sales Per Month
          • Stats
        • MSAAQPay
          • Best sales
          • Stats
        • Reports
          • Customers
            • export
            • Customers/members Country
            • Customers/most Orders
            • Customers/stats
            • Customers/chart
          • Analytics
            • export
            • Analytics/top Referrers
            • Analytics/most Visited Pages
            • Analytics/session devices
            • Analytics/session countries
            • Analytics/stats
            • google analytics scopes
            • get google analytics access token
          • Orders
            • export
            • top-sources
            • top-days
            • sells-chart
            • chart
            • stats
          • Products
            • Products
            • Courses
            • export
            • Top Selling
          • Campaigns
            • export
            • stats
      • Members
        • Segments
          • export
          • delete
          • update
          • create
          • show
          • list
          • grant access segment
        • Access
          • Grant Member Access
          • Remove Member Access
          • Grant access by email
          • Remove access by email
        • Delete Member
        • Update Member
        • Get Member
        • sendResetLinkEmail
        • Create
        • export
        • import
        • List Members
        • Unsubscribe from newsletter
        • subscribe from newsletter
        • Get Member by Email
      • Courses
        • Chapters
          • Contents
            • Create
              • Create zoom meetig
              • Create meeting
              • Create text
              • Create survey
              • Create embed
              • Create PDF
              • Create audio
              • Create Assignment
              • Create Video
              • Create Quiz
              • Create Interactive element
              • Create Interactive question
            • Update
              • Publish Quiz
              • Update Quiz
              • Archive Quiz
              • Update Interactive element
              • Update Interactive question
              • Update meeting
              • Update Survey
              • Update embed
              • Update assignment
              • Update video
            • replicate content
            • delete content
            • Show Content
            • List Content
          • Drip
          • Sort
          • Delete
          • Update
          • Create
          • Get chapter
          • List Chapters
        • Get Course Attendance
        • Replicate course
        • Delete Course
        • Update Course
        • Create Course
        • Get Course stats
        • Get Course
        • Export Courses
        • List Courses
      • Videos
        • Delete Video
        • Update Video
        • Get Video Uesage
        • Get Video
        • Create
        • list
      • Quizzes
        • Question
          • Create Questions
          • Delete question
          • Sort Question
          • Replicate Question
          • Update Question
          • Get single question
          • List of questions
        • export Quiz Members
        • export
        • Get Survey members
        • Get Quiz members
        • Delete Quiz
        • Update Quiz
        • Get Quiz
        • Create
        • list attempts
        • Show Quiz
        • List Quizzes
      • Taxonomies
        • Delete Category
        • Update Category
        • Get Category usage
        • Get Category
        • Create
        • list
      • Builder
        • Pages
          • Delete Page
          • Replicate Page
          • Update Page
          • Get Page
          • Create
          • list
        • Blocks
          • list
        • Menus
          • Menu options
          • deleteLink
          • show
          • save
          • list
        • update
        • options
      • Enrollments
        • export
        • List Enrollments
      • Dowloads
        • export
        • Remove Tenant
      • Tags
        • Export Tags
      • Currencies
        • list
      • Countries
        • list
      • Certificates
        • list certificates
        • previiew
        • Delete
        • create
      • Certificates Templates
        • replicate
        • Delete
        • Update certificate
        • create
        • Get single
        • list
      • Appointments
        • cancel
        • list
      • Difficulties
        • Delete Difficulty
        • Update Difficulty
        • Get Difficulty
        • Create
        • list
      • Assigment Members
        • Update assignment member
        • Get assignment member
        • export
        • List
      • Assignments
        • List Assignment Segments
        • Get assignment
        • list
      • Products
        • (deprecated) check google calendar
        • Replicate
        • Delete product
        • Update product
        • Get product stats
        • Get product
        • Create
        • export
        • downloads export
        • downloads
        • list
        • Get product
      • Articles
        • Delete article
        • Upload editor media
        • Update article
        • duplicate article
        • Get article
        • Create
        • export
        • list
      • Webhooks
        • Delete Webhook By URL
        • Delete Webhook
        • Update Webhook
        • Create Webhook
        • Show Webhook
        • List Webhooks
      • Domains
        • DNS
          • Delete
          • Update
          • Create
          • list
        • domains/delete
        • domains/verify-activation
        • domains/make-default
        • domains/create
        • domains/show
        • domain/list
      • Comments
        • Reply
          • List Comment Replies
        • Like
        • Reply
        • Show Comment
        • Update Comment
        • Delete comment
        • Get comment
        • list
      • Reviews
        • Delete comment
        • reply
        • Update review
        • Get review
        • list
      • Orders
        • Get order invoice
        • Get order
        • export
        • list
      • Cancellation Reasons
        • list
      • Bank Transfers
        • update
        • Get bank transfer
        • list
      • Coupons
        • Delete coupon
        • Update coupon
        • Get coupon
        • Create Coupon
        • coupon stats
        • export uses
        • list of uses
        • list
        • export coupon uses
      • Campaigns
        • Delete campaign
        • Update campaign
        • Send test campaign
        • Preview campaign
        • Get campaign sends
        • Get campaign
        • Export campaigns
        • Create campaign
        • estimate-message-volume
        • list campaigns
        • grant 100 free emails
        • Replicate campaign
        • Export campaign
        • Export campaign sends
      • Affiliates
        • Get Settings
        • Setting
        • update paypout
        • Get payout
        • Payout list
      • Msaaq Affiliates
        • Payouts
          • Payout
          • payout receipt
          • payout show
          • payouts list
        • Get Info
      • Settings
        • Academy Email Domain
          • Store email domain
          • Get email domains
          • Update email domain
          • Delete email domain
        • Tenant Email Domain
        • {{baseUrl}}/admin/settings
        • {{baseUrl}}/settings/translations
        • supported languages
        • translations
        • Customize registeration form
        • Update settigs
        • Update translations
      • MsaaqPay
        • Transactions
          • refund
          • Invoice
          • Get transaction
          • export
          • List Transactions
        • Payouts
          • Receipt
          • Get payout
          • Create payout
          • Setting
          • list
        • Settlement
          • Var Invoice
          • Report
          • Receit
          • Get settlemtn details
          • list
        • setting
        • setting
      • Apps Marketplace
        • Get analytics properties list
        • Get convertkit lists
        • Get mailchimp lists
        • uninstall app
        • Install app
        • callback
        • Show
        • List
      • Academy Verification
        • Nelc License
          • Get nelc products
          • Nelc License Checkout
        • Acccept msaaqpay contract
        • Entity msaaqpay contract
        • Get entity
        • Wathq check
        • Status
        • Start verify
      • Billing
        • Subscription
          • Validate Promo Code
          • Swap
          • Unpause
          • Addon Subscribe
          • Subscribe
          • Pause
          • subscription
        • SMS
          • purchase
          • Settings
          • Bundles
        • Strip
          • Cards
            • Mark As default
            • Create Card
            • Delete card
            • List
          • Subscriptions
            • Swap
            • Resume
            • Cancel
            • Create
            • Get
            • List
          • setup-intent
        • Emails Plans
        • plans
        • receipts
      • Notifications
        • Update Mail Template
        • Upadte Settings
        • markARead
        • List
        • Settings
      • Apps
        • Salla
          • Get product
          • products
      • Search
        • search
      • Abandoned Carts
        • destroy reminder
        • show reminder
        • update reminder
        • custom reminder
        • store reminder
        • reminders
        • export
        • stats
        • list
      • Announcements
        • announcements
        • mark as read
      • Onboarding
        • Onboarding Questionnaire
          • questions/answers
          • questions
        • Onboarding Checklist
          • mark as completed
          • onboarding checklist
        • onboarding
        • mark as read
      • Forms
        • Create | Update Form
        • Show Form
      • Bank
        • Update
        • Get currenent user bank
        • Create
      • Coaching sessions
        • check google calendar
        • Replicate
        • Delete
        • Update
        • Get stats
        • Details
        • Create
        • downloads
        • List
        • export
        • download export
      • Learning Paths
        • Course
          • Sync Learning Path Courses
          • List Learning Path Courses
        • List learning paths
    • Tenant
      • Getting Started with Tenant API
      • Auth
        • Me
        • Logout
        • Passwordless
        • Reset Password
        • Forget Password
        • Validate-recaptcha
        • Authorize Verify
        • Authorize
        • Register
        • Email Verify
      • Reviews
        • Delete Review
        • Update Review
        • Create Review
        • Reviews distribution
        • List Reviews
      • Account
        • Update login credentials
          • Change password
          • verify
          • Update login credentials
        • Affliates
          • Withdraw Request
          • payouts
          • Info
        • Banks
          • Remove Bank Acount
          • Update Bank Account
          • Create Bank
          • Show bank
        • Calendar
          • Calendar
        • Change password by signed
        • Unsubsribe
        • Update Account
        • Get order invoice
        • Last viewed course/learning path
        • List User's Appointments
        • User Stats
        • List User's Rejected Assignments
        • List User's Assignments
        • List User's Quizzes
        • List User's Upcomming Appointments
        • List User's Products
        • List User's Courses
        • List User's Learning Paths
        • Last User's Orders
      • Certificates
        • Verify Certificate
        • Download Certificate
        • List User's Certificates
      • Currencies
        • List of currencies
      • Newsletter
        • Unsubscribe
        • Subscribe
        • Request subscribe
      • Cart
        • Checkout
        • Redeem Coupon
        • Express Checkout
        • Remove From Cart
        • Add To Cart
        • Get cart by uuid
        • Get Current Cart
        • Get card token
      • Courses
        • Overview
        • Chapters
          • Contents
            • Comments
              • Create Comment's Reply
              • Delete Comment
              • Update Comment
              • Create Comment
              • List Comments
            • Quizzes
              • Close Attempt
              • Submit Survey Answer
              • Submit Quiz Answer
              • Survey Attempt Details
              • Quiz Attempt Details
              • Attempt Survey
              • Attempt Quiz
            • Assignments
              • Resubmit Assignment
              • Submit Assignment
            • Mark Content as Complete
            • Join meeting
            • Content Attachmet Dowload
            • Content Details
            • List Chapter's Contents
          • Chapter Details
          • List Chapters
        • Get QR code
        • Course Details
        • Course Certificate
        • List Best Selling Courses
        • List Interesting Courses
        • List Courses
      • Payments
        • Tap callback
      • Pages
        • Contact Us
        • Page Details
        • Privacy Page
        • About Us
        • Terms Page
        • Home Page Details
      • Articles
        • Comments
          • Create replay
          • Delete Comment
          • Update Comment
          • Create comment
          • List of comments
        • Article Details
        • List of Articles
      • Instructors
        • Instructor Details
        • List of Instructors
      • Taxonomies
        • Get Taxonomy details
        • List of Taxonomies
      • Products
        • Interesting Products
        • Interesting Products
        • Download Product media
        • Available Appointments
        • Product Details
        • Best sales products
        • List Products
      • Appointments
        • book appointment
        • show Appointments Details
        • List Appointments
      • Comment
        • List Comment Replies
      • Learning paths
        • Learning path Details
      • notifications
        • list
        • mark as read
      • Assignment
        • List Assignment Segments
      • Get Sitemap
        GET
      • Get Translations
        GET
      • Search
        GET
      • Well Know
        GET
      • Ping Pong
        GET
      • Get Tenant Details
        GET
    • Assignment
  1. Tenant

Getting Started with Tenant API

Msaaq Tenant API Reference#

The Tenant API is used serve the Tenantfront actions and operations, including Tenant User authentication, making payments, retrieving courses, digital products, consulting sessions, bundles, and everything else related to a tenant. There are no roles in the Tenant API, all requests are made on behalf of the visitors or the Tenant Users.
TL;DR: Whatever visitors or Tenant Users see or do on the Tenantfront is powered by the Tenant API.

API Base URL#

When making requests to the Tenant API, make sure that you're adding the /tenant path to the base URL https://api.msaaq.com/v1, like so: https://api.msaaq.com/v1/tenant.

Headers#

Accept-Language#

Including a two letter language code (ISO 639-1 e.g., en, ar) in the Accept-Language header will return the response in the specified language. If the specified language is not available, the response will be in English.
This Header is optional and the default language is English.

X-Tenant#

All requests to the Tenant API should include the header X-Tenant with the value of the Tenant's default domain (e.g., tenant_slug.msaaq.net) or custom domain (e.g., custom-domain.com). This header is used to identify the Tenant that the request is being made on behalf of.
If the X-Tenant header is not provided, you will receive the following 400 Bad Request response in all requests:
{
    "status": "failed",
    "code": "TENANT_HEADER_NOT_PROVIDED",
    "message": {
        "body": "No Tenant header was provided"
    }
}
If the X-Tenant header is provided but with an invalid value, you will receive the following 400 Bad Request response:
{
    "status": "failed",
    "code": "TENANT_NOT_FOUND",
    "message": {
        "body": "Tenant not found"
    }
}
See it in action:

Request#

cURL
JavaScript
Python
PHP

Response#

200
TENANT_HEADER_NOT_PROVIDED 400
TENANT_NOT_FOUND 400
{
    "message": "pong!"
}
Previous
List learning paths
Next
Me
Built with