Show User Details

GET

/v2/employee/:employeeId

GET

/v2/employee/:employeeId

curl https://api.megaport.com/v2/employee/employeeId

{
  "data": {
    "active": true,
    "altId": null,
    "channelManager": null,
    "confirmationPending": false,
    "dateOfBirth": null,
    "description": "",
    "email": "jeff@megaport.com",
    "emails": [
      {
        "badEmail": false,
        "badEmailReason": null,
        "badEmailType": null,
        "email": "jeff@megaport.com",
        "emailAddressId": 37399,
        "primary": true
      }
    ],
    "facebook": null,
    "featureFlags": [],
    "firstName": "Jeff",
    "googlePlus": null,
    "invitationPending": false,
    "lastName": "Megaport",
    "linkedin": null,
    "mfaEnabled": false,
    "mobile": "+61 457702046",
    "mobileValidationDate": null,
    "name": "Jeff Megaport",
    "newsletter": false,
    "notificationEnabled": true,
    "partyId": 45115,
    "phone": "+61 457702046",
    "position": "Company Admin",
    "promotions": false,
    "receivesChildNotifications": false,
    "requireTotp": false,
    "salutation": "",
    "securityRoles": [
      "companyAdmin"
    ],
    "twitter": null,
    "uid": "c3cd47e7-20ed-41c3-92ce-b31ad8e3c29e",
    "username": "jeff@megaport.com"
  },
  "message": "Found Employee 45115",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Returns user information for the user specified by the employee ID.

You can find the employee ID (personId) using the GET List Company Users /v2/employment endpoint.

The response includes the position, name, email address, phone number, username, whether the user is active or not, Megaport role, Megaport permissions, and whether MFA is enabled for the user.

Path parameters

employeeIdstringRequired

Response

Show User Details - Success / Show User Details - Success

dataobjectOptional

messagestringOptional

termsstringOptional

Errors

401

Unauthorized Error

404

Not Found Error