Skip to content
  • There are no suggestions because the search field is empty.

Get Users in Phin Api Route

This route is used to get a list of all users under a company in Phin. This is the primary way to get user information and userIds for use in other API routes.

User Attribute Reference

Field Name Description Value Type Optional (Y/N)
id Unique Id of the user String N
first First name String N
last Last name String N
email Email String N
status Status in Phin (active/slept) String N
deptname Department Name String Y
supvemail Supervisor Email String Y
supvname Supervisor Name String Y
ophone Office Phone Number (Azure only) String Y
phone Phone number String Y
welcomed Has this user received a welcome email? Boolean N
createdBy "UserSync" if the user was created by an integration or "" if the user was created manually. String N

 

Response Reference

Field Type Example
users array[user] [{ “userId”: “sampleId”, “first”: “Don”, “last”: “Johnson”, "email": "djohnson@example.com"...}]

Response Sample

{ "users":
  [
    {
      "userId": “sampleId”,
      "first": “Pepe”,
      "last": “Silvia”,
      "email": "pepe@example.com",
      "status": "active",
      "welcomed": false, 
      "createdBy: "UserSync"  
    }
  ]
}

Error Reference

Code Message Explanation
500 Failed to get users. Please try again or contact Phin Support for assistance. Something went wrong fetching the inventory of users. Try again later or contact Phin.