/users

Search for users.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

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.

Query Params
int32
Defaults to 10

Number of results to return. Max 100.

int32
Defaults to 0

Specifies the number of rows to skip before starting to return results.

string

Field to sort by. (Currently only id, name and created are available.)

string

Find users by a specific role. (e.g., "Broker", "Agent", "Lender")

string

Find a user by their full name. (Exact matches only, no partial matching available.)

string

Find a user by their email.

string

Comma separated list of fields (e.g., id,name,calling) to return or use allFields to return all fields (except for calling information, unless included like allFields,calling).

When using the fields parameter to filter the response, the id field will be included (even when not specified explicitly).

boolean
Defaults to false

Setting this to true will include users that have been deleted.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json