API Reference

Authentication

When the API requires authentication, this page shows the user how to get proper authentication for the API.

Authentication is required to use the API. We use a token based system that is tied to a specific user. Every user in the system can have their own API token that is tied to their specific permissions

Creating your API token

Admin Privileges are needed to get access to these pages. If these pages are not visible, please see your MotionCX Admin.

Navigate to:

  1. Administration
  2. Users
  3. Locate User
  4. Actions > API Keys tab
1814

Using your token

Your API token can be used two ways.

Once you have a token you can provide it as an Authorization: apiKey header in your requests, as shown below.

curl --request GET \
     --url https://api.motioncxapps.com/reporting/api/v1/lookup/queues \
     --header 'Accept: text/json' \
     --header 'Authorization: apikey odQasdfasdfgeLEw=:x9xOyX2kfoD1IkO0sadfasdfasdfasdfsdfjjtreyjutykbrxHgP4='

Or, as an x-api-key header

curl --request GET \
     --url https://api.motioncxapps.com/reporting/api/v1/lookup/queues \
     --header 'Accept: text/json' \
     --header 'x-api-key: odQasdfasdfgeLEw=:x9xOyX2kfoD1IkO0sadfasdfasdfasdfsdfjjtreyjutykbrxHgP4='