/users

📘

Calling Information

By default, this endpoint does not return calling information about the phone number associated with Follow Up Boss.

In order to retrieve this additional information, use the fields argument and include calling and any other fields needed from the user object.

📘

Role Mapping

Currently, the role value in the response will only map to three options: Agent, Broker and Lender. Broker is the same as an Owner in the front end of Follow Up Boss if isOwner is also true, otherwise they are just an Admin.

By utilizing the teamLeaderOf results in the response along with the role itself, you can make other connections. For example, if a user is an Agent and teamLeaderOf contains the id of 1 in the list, that means the user is a Team Leader / ISA Role in Follow Up Boss.