Polaris Users

Get Polaris User

GET /api/.../polarisusers?externalId={externalId}

Return polaris user data, including email and group data.

Request Information

Parameters
Name Type Required Description
externalId String Yes The unique external id assigned to the polaris user.

Response Information

Example
application/json, text/json
{
  "Groups": [
    {
      "GroupID": 1,
      "GroupName": "Administrator"
    },
    {
      "GroupID": 385,
      "GroupName": "Administrator minus SA permissions"
    },
    {
      "GroupID": 394,
      "GroupName": "Administrator (Bryan)"
    },
    {
      "GroupID": 397,
      "GroupName": "Administrator (Semir)"
    }
  ],
  "Email": "polarisexec@iii.com",
  "RecordStatusID": 1,
  "PolarisUserID": 1,
  "OrganizationID": 144,
  "ExternalID": "testID",
  "Name": "PolarisExec",
  "BranchID": null,
  "Enabled": true,
  "CreatorID": 1,
  "ModifierID": 1,
  "CreationDate": "2011-02-16T20:28:16.177-05:00",
  "ModificationDate": "2021-11-04T15:54:33.473-04:00"
}

Required Permissions

Permission IDs found here.

StaffMembers_Access(ownerID)

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found