Get Users in Phin Api Route

The "Get Users" API route in Phin retrieves a list of all users under a company, providing detailed user attributes such as unique ID, name, email, status, department, supervisor info, phone numbers, welcome email status, and creation method, returning an array of user objects or a 500 error if the retrieval fails.

Overview

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

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

Response Reference

users: array of user objects
- Example: [ { "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

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