list_users
Search and retrieve users from Follow Up Boss CRM. Filter by name, email, or role, paginate large result sets, and request only needed fields.
Instructions
Search for users. (GET /users) 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Find a user by their full name. (Exact matches only, no partial matching available.) | |
| role | No | Find users by a specific role. (e.g., "Broker", "Agent", "Lender") | |
| sort | No | Field to sort by. (Currently only `id`, `name` and `created` are available.) | |
| No | Find a user by their email. | ||
| limit | No | Number of results to return. Max 100. | |
| fields | No | 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). <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. | |
| 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. | |
| includeDeleted | No | Setting this to `true` will include users that have been deleted. |