Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Person → Get Many

AI-generated

Summary

Retrieve multiple people from Follow Up Boss with optional filters, sorting, and pagination.

Inputs

  • authentication — Authentication method to use for the API request; defaults to API Key.
  • returnAll — Whether to return all results or only up to a given limit; defaults to false.
  • limit — Max number of results to return when returnAll is false; defaults to 50; minimum is 1.
  • assignedLenderId — Search for people by the assigned lender user ID; can be specified by ID or selected from a list.
  • assignedLenderName — Search for people by the assigned lender name.
  • assignedTo — Search for a person by the user that is assigned to them.
  • assignedUserId — Search for people by the assigned user ID; can be specified by ID or selected from a list.
  • contacted — Whether the person has been contacted; defaults to false.
  • createdAfter — Filter records created after a given date/time.
  • createdBefore — Filter records created before a given date/time.
  • customFields — Filter by custom field name and value; supports multiple values.
  • email — Search for a person by email address.
  • firstName — Search for person with a first name like what is given.
  • idGreaterThan — Filter records with an ID greater than the specified value; defaults to 0.
  • idLessThan — Filter records with an ID less than the specified value; defaults to 0.
  • ids — A comma-separated list of IDs to retrieve.
  • includeTrash — Whether to include people in the 'trash' stage; defaults to false.
  • includeUnclaimed — Whether to include unclaimed leads offered to the current user; defaults to false.
  • lastActivityAfter — Search for last activity after a given time.
  • lastActivityBefore — Search for last activity before a given time.
  • lastName — Search for person with a last name like what is given.
  • name — Search for person with a name like what is given.
  • phone — Search for a person by phone number.
  • assignedPondId — Search for a person by the assigned pond ID; can be specified by ID or selected from a list.
  • priceAbove — Search for people who have specified a price above a given value.
  • priceBelow — Search for people who have specified a price below a given value.
  • smartListId — Search for people that match a smart list with given ID; can be specified by ID or selected from a list.
  • source — Search for a person by lead source.
  • stage — Search for person by stage name; can be specified by ID or selected from a list.
  • tags — Search for people that match one or more tags (comma-separated).
  • updatedAfter — Filter records updated after a given date/time.
  • updatedBefore — Filter records updated before a given date/time.

Output shape

Array of person objects matching the specified filters.

The 'sort' parameter can be used to control result ordering via a fixed collection of field and direction. The 'simplify' parameter, when true, returns a simplified response shape instead of raw data.

Links

Discussion