User Information

This gives all the information about a user, this is most commonly an Agent.
Authentication required, please visit this page for Authentication How To.

Parameters

TenantID - How your specific customer instance is identified, this will be a number. Find this in the app Help (?) icon > MotionCX Voice > Tenant:
Email - All users must have an email as their username.
It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

Example return:

{
  "mcxUserInfo": {
    "expireDate": null,
    "uuid": "54fa90f6-40ff-4f14-bfc5-5b1c0e89fc90",
    "email": "[email protected]",
    "isSuperUser": false,
    "tenants": [
      {
        "uuid": "54fa90f6-40ff-4f14-bfc5-5b1c0e89fc90",
        "userId": 13735,
        "tenantId": 2,
        "tenantName": "ContactCenter",
        "tenancyName": "ContactCenter",
        "firstName": "Imma",
        "lastName": "Getdeleted",
        "phoneNumber": null,
        "tenantGuid": "3a0cc40e-b095-4642-ab23-5e3ed4be1b02",
        "roles": [],
        "groups": [],
        "queues": [],
        "isAdmin": false
      }
    ],
    "currentTenant": {
      "uuid": "54fa90f6-40ff-4f14-bfc5-5b1c0e89fc90",
      "userId": 13735,
      "tenantId": 2,
      "tenantName": "ContactCenter",
      "tenancyName": "ContactCenter",
      "firstName": "Imma",
      "lastName": "Getdeleted",
      "phoneNumber": null,
      "tenantGuid": "3a0cc40e-b095-4642-ab23-5e3ed4be1b02",
      "roles": [],
      "groups": [],
      "queues": [],
      "isAdmin": false
    },
    "isExpired": false,
    "info": "Authorization accepted",
    "userName": "[email protected]",
    "currentTenantId": 2,
    "mcxPermissionType": 0
  },
  "email": "[email protected]",
  "userName": "[email protected]"
}