List Company Users

GET

/v2/employment

GET

/v2/employment

curl https://api.megaport.com/v2/employment

200Retrieved

{
  "data": [
    {
      "active": true,
      "billingContact": true,
      "companyId": 1153,
      "companyName": "Megacompany",
      "email": "kate.peters@example.com",
      "emails": [
        {
          "badEmail": false,
          "badEmailReason": null,
          "badEmailType": null,
          "email": "kate.peters@example.com",
          "emailAddressId": 47162,
          "primary": true
        }
      ],
      "employmentId": 51193,
      "employmentType": "REAL",
      "featureFlags": [],
      "firstName": "Kate",
      "invitationPending": false,
      "lastName": "Peters",
      "mfaEnabled": false,
      "mobile": null,
      "name": "Kate Peters",
      "notificationEnabled": true,
      "password": null,
      "permissions": [
        "financials",
        "agent_create_employee",
        "agent_create_sub_agency",
        "tickets",
        "approve_order",
        "agent_end_user",
        "services",
        "tools",
        "modify_service",
        "position_manager",
        "marketing",
        "graphs",
        "place_order",
        "company_admin",
        "virtual_employee",
        "notifications"
      ],
      "personAltId": null,
      "personId": 57278,
      "personUid": "cec8e72a-5491-47bf-af2e-0a241e14c679",
      "phone": null,
      "position": "Company Admin",
      "positionId": 1983,
      "requireTotp": false,
      "securityRoles": [
        "companyAdmin"
      ],
      "technicalContact": true,
      "username": "kate.peters@example.com"
    },
    {
      "active": true,
      "billingContact": true,
      "companyId": 1153,
      "companyName": "Megacompany",
      "email": "Simon.Bailey@example.com",
      "emails": [
        {
          "badEmail": false,
          "badEmailReason": null,
          "badEmailType": null,
          "email": "Simon.Bailey@example.com",
          "emailAddressId": 31578,
          "primary": true
        }
      ],
      "employmentId": 34796,
      "employmentType": "REAL",
      "featureFlags": [],
      "firstName": "Simon",
      "invitationPending": false,
      "lastName": "Bailey",
      "mfaEnabled": false,
      "mobile": null,
      "name": "Simon Bailey",
      "notificationEnabled": true,
      "password": null,
      "permissions": [
        "financials",
        "agent_create_employee",
        "agent_create_sub_agency",
        "tickets",
        "approve_order",
        "agent_end_user",
        "services",
        "tools",
        "modify_service",
        "position_manager",
        "marketing",
        "graphs",
        "place_order",
        "company_admin",
        "virtual_employee",
        "notifications"
      ],
      "personAltId": null,
      "personId": 38596,
      "personUid": "8319368d-896a-48fc-a0d0-2ba3149d919c",
      "phone": null,
      "position": "Company Admin",
      "positionId": 1983,
      "requireTotp": false,
      "securityRoles": [
        "companyAdmin"
      ],
      "technicalContact": true,
      "username": "Simon.Bailey@example.com"
    },
    {
      "active": false,
      "billingContact": true,
      "companyId": 1153,
      "companyName": "Megacompany",
      "email": "regulatory@example.com",
      "emails": [
        {
          "badEmail": false,
          "badEmailReason": null,
          "badEmailType": null,
          "email": "regulatory@example.com",
          "emailAddressId": 45173,
          "primary": true
        }
      ],
      "employmentId": 49383,
      "employmentType": "REAL",
      "featureFlags": [],
      "firstName": "Regulatory",
      "invitationPending": false,
      "lastName": "Megacompany",
      "mfaEnabled": false,
      "mobile": null,
      "name": "Regulatory Megacompany",
      "notificationEnabled": true,
      "password": null,
      "permissions": [
        "graphs",
        "tickets",
        "approve_order",
        "place_order",
        "services",
        "tools",
        "notifications",
        "modify_service"
      ],
      "personAltId": null,
      "personId": 54677,
      "personUid": "ba3e8eaa-3552-49c9-b58e-bc3b454a48e3",
      "phone": "+611231234",
      "position": "Technical Admin",
      "positionId": 5873,
      "requireTotp": false,
      "securityRoles": [
        "technicalAdmin"
      ],
      "technicalContact": true,
      "username": "regulatory@example.com"
    },
    {
      "active": false,
      "billingContact": true,
      "companyId": 1153,
      "companyName": "Megacompany",
      "email": "cdaniel@example.com",
      "emails": [
        {
          "badEmail": false,
          "badEmailReason": null,
          "badEmailType": null,
          "email": "cdaniel@example.com",
          "emailAddressId": 613,
          "primary": true
        }
      ],
      "employmentId": 646,
      "employmentType": "REAL",
      "featureFlags": [],
      "firstName": "Craig",
      "invitationPending": false,
      "lastName": "Daniel",
      "mfaEnabled": false,
      "mobile": null,
      "name": "Craig Daniel",
      "notificationEnabled": false,
      "password": null,
      "permissions": [
        "financials",
        "agent_create_employee",
        "agent_create_sub_agency",
        "tickets",
        "approve_order",
        "services",
        "agent_end_user",
        "tools",
        "modify_service",
        "position_manager",
        "marketing",
        "graphs",
        "place_order",
        "company_admin",
        "virtual_employee",
        "notifications"
      ],
      "personAltId": null,
      "personId": 740,
      "personUid": "22b12c35-46f1-4b5a-9815-c0e308daceec",
      "phone": "1",
      "position": "Manager",
      "positionId": 374,
      "requireTotp": false,
      "securityRoles": [
        "technicalContact",
        "companyAdmin"
      ],
      "technicalContact": true,
      "username": "cdaniel@example.com"
    }
  ],
  "message": "Found Employments for Company 1153",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Returns user information for all users in the company. The response includes the name, email address, phone number, username, Megaport role, Megaport permissions, and whether MFA is enabled for the user.

Response

List Company Users - Success / List Company Users - Success

datalist of objectsOptional

messagestringOptional

termsstringOptional