list_people
Search Follow Up Boss CRM for people by name, email, phone, tags, stage, or custom fields. Retrieve paginated results with selective fields for efficient contact lookup.
Instructions
Search for people. (GET /people) Defaults to limit=100 (FUB's max per page) rather than its own default of 10 — bulk requests are the common case here. If the response's _metadata shows more results remain, keep paginating: use offset for offset-based endpoints, or the _metadata.next cursor value (as the next argument) for cursor-based endpoints like notes. Use fields to request only what you need instead of full records when scanning many people. For custom fields, call list_custom_fields first to discover the exact field names/labels rather than guessing. FUB's docs also list a wildcard "custom*" field here for reading/writing custom fields directly (e.g. a "Closing Date" field as custom.ClosingDate) — that's not a literal field name, so it's not in this tool's fixed schema. Pass custom. entries via extraQuery instead. Call list_custom_fields first to get exact names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The ID(s) of a person or people. (e.g., "123,456") | |
| name | No | Search for person with a name like what is given. (e.g., If you search for "drew", it might return a contact like "Andrew".) | |
| sort | No | The sort order, can be one of the following: `id`, `created`, `updated`, `name`, `firstName`, `lastName`, `price`, `stage`, `lastActivity`, `lastCommunication`, `lastReceivedEmail`, `lastSentEmail`, `lastEmail`, `emailsReceived`, `emailsSent`, `lastIncomingCall`, `lastOutgoingCall`, `lastCall`, `firstCall`, `callsIncoming`, `callsOutgoing`, `callsDuration`, `lastReceivedText`, `lastSentText`, `lastText`, `lastLeadActivity`, `lastEmEventActivity`, `lastIdxVisit`, `textsReceived`, `textsSent`, `propertiesViewed`, `propertiesSaved`, `pagesViewed` or `nextTask`. <br /><br />Custom Fields (e.g. `customClosePrice`) can also be used in sorting. | created |
| tags | No | Search for people that match one or more tags. (e.g., "Foo,Bar" will match contacts with tags that include Foo OR Bar.) | |
| No | Search for a person by email address. | ||
| limit | No | Number of results to return. Max 100. | |
| phone | No | Search for a person by phone number. | |
| stage | No | Search for person by stage name. (e.g., "Lead" or "Trash". See [stages API endpoint](ref:stages-get) for available stages.) | |
| fields | No | Comma separated list of fields to return or use `allFields` to return all fields. (e.g., `firstName,lastName,timeframeId,timeframeUpdated,timeframeStatus,customFieldName`). Note: All custom fields should be prefixed with `custom` (i.e. customBirthday, customField). <br><br> Special values include `allCustom` (returns all custom fields) and `allFields` (returns all fields, including custom fields). <br><br> When using the `fields` parameter to filter the response, the `id` field will be included (even when not specified explicitly). | |
| offset | No | Specifies the number of rows to skip, before starting to return results. | |
| source | No | Search for a person by lead source. | |
| lastName | No | Search for person with a last name like what is given. (e.g., If you search for "drew", it might return a contact like "Andrew".) | |
| contacted | No | Search for people by whether or not they have been contacted. | |
| firstName | No | Search for person with a first name like what is given. (e.g., If you search for "drew", it might return a contact like "Andrew".) | |
| assignedTo | No | Search for a person by the user that is assigned to them. (e.g., Passing "William Riker" would return any person assigned to them.) | |
| extraQuery | No | Extra raw query parameters not explicitly listed above — e.g. FUB custom field filters like custom.ClosingDate on /people or /deals. Keys and values are sent as-is. | |
| priceAbove | No | Search for people who have specified a price above a given value. | |
| priceBelow | No | Search for people who have specified a price below a given value. | |
| smartListId | No | Search for people that match a smart list with given ID. | |
| includeTrash | No | Set whether to include people in the "trash" stage. (By default responses from /people will not include any people with a "trash" stage.) | |
| assignedPondId | No | Search for a person by the assigned pond id. | |
| assignedUserId | No | Search for people by the assigned user ID. | |
| assignedLenderId | No | Search for people by the assigned lender user ID. | |
| includeUnclaimed | No | Set to include unclaimed leads offered to the current user. | |
| lastActivityAfter | No | Search for last activity after a given time. (e.g., "2016-11-23 01:02:03") | |
| assignedLenderName | No | Search for people by the assigned lender name. | |
| lastActivityBefore | No | Search for last activity before a given time. (e.g., "2016-11-23 01:02:03") |