Outreach

ID of an account. Must be a positive integer.

A specific question about the account to ask. Cannot be an empty string.

An optional end date to filter the account data.

An optional start date to filter the account data.

Input model containing account creation details. All values MUST come directly from the user. Never guess or fabricate any field value. ALWAYS call input_fields_fetch first to discover available additional fields and their types.

ID of an account (not an opportunity ID, prospect ID, or user ID). Must be a positive integer. Common sources: any tool result that returns an account object (account.id field), conversation context, or injected context from the UI.

Extra account fields to fetch. Pick only fields needed to answer the user's query. Examples: - "What's the headcount?" → ["number_of_employees", "number_of_employees_listed_on_linkedin"] - "Are there upcoming meetings?" → ["number_of_upcoming_meetings"] - "Tell me about their account plan" → ["account_plan_layout_id", "account_plan_updated_at_date"] - "Which CRM?" → call `filter_fields_fetch` tool to get [..., {"id": "custom8", "label": "Current CRM"}, ...] → ["custom8"] Available named fields: - "account_plan_layout_id" — GUID of the account plan layout - "account_plan_updated_at_date" — when the account plan was last updated - "annual_revenue_range" — annual revenue range (e.g. "$10M-$50M") - "description" — short free-text description of the account - "linkedin_url" — LinkedIn company profile URL - "locality" — city or locality - "naics_codes" — NAICS industry classification codes - "number_of_employees" — headcount from Outreach record (0 means unknown; prefer number_of_employees_listed_on_linkedin for estimates) - "number_of_employees_listed_on_linkedin" — LinkedIn headcount - "number_of_upcoming_meetings" — count of upcoming scheduled meetings - "sic_codes" — SIC industry classification codes - "tags" — user-defined tags on the account - "website_url" — company website URL If the user query cannot be answered with a default or additional named field, use `filter_fields_fetch` tool with entity_type="account" to get the list of valid custom field IDs which can be used.

Optional. Only return account account_plan_updated_at after this time. If only account_plan_updated_at_after is provided without account_plan_updated_at_before, the search will return accounts account_plan_updated_at in 90 days after account_plan_updated_at_after.

Optional list of additional field filters applied with AND logic alongside the named parameters above. Each filter must include: - "attribute": field id from filter_fields_fetch (ex. "custom8") - "value": list of filter values (always strings). For operator "is": multiple values match with OR logic (ex. ["High", "Medium"]). For all other operators: provide a single value in the list (ex. ["1000000"] or ["salient seller"]). - "operator": what function to perform on "value" to produce search results (ex. "is") Allowed operators by field validation_type: - "string": is, contains, startswith - "inclusion": is - "numerical": gte, lte, is - "currency": gte, lte, is Operator definitions: - "gte": matches fields greater than or equal to Filter.value - "lte": matches fields less than or equal to Filter.value - "is": matches exact string equality between field and Filter.value - "contains": matches fields that contain Filter.value as a substring - "startswith": matches fields that start with Filter.value Rules: - For filter fields with validation_type of "inclusion", use values exactly as returned in validation_definition (case-sensitive).

Additional fields to include in the output. Omit or pass null if default fields suffice. Only accepts custom field IDs discovered via `filter_fields_fetch` (e.g. "custom8"). Only pick fields needed to answer the user's query. Example: - "Which CRM do these accounts use?" → call `filter_fields_fetch` tool to get [..., {"id": "custom8", "label": "Current CRM"}, ...] → ["custom8"]

Optional. Only return account created after this time. If only created_after is provided without created_before, the search will return accounts created in 90 days after created_after.

Optional. Only return account created before this time. If only created_before is provided without created_after, the search will return accounts created in 90 days before created_before.

Filter by a list of account IDs. Returns only accounts whose ID is in this list.

Only return accounts last contacted over email, meetings or calls after this date. Use this to find accounts WITH recent activity, e.g. set to (now - 30 days) to find accounts contacted in the last 30 days.

Only return accounts last contacted over email, meetings or calls before this date. Use this to find accounts WITHOUT recent activity, e.g. set to (now - 30 days) to find accounts not contacted in the last 30 days.

Maximum number of accounts to return.

full name or partial account name to search. Cannot be an empty string.

Pagination offset used for fetching accounts.

Filter by a list of user IDs who own or are assigned to the accounts. Returns accounts where the owner or assigned user matches any of the provided IDs.

The field to sort by. ONLY supported sort fields are: - "buyer_intent_score" - "created_at" - "last_contacted_at" - "updated_at" The field should be in the format "-field" for descending order or "field" for ascending order.

Filter by the ID of the team who owns the accounts

ID of the associated object in external systems to search. Cannot be an empty string.

Optional list of filter criteria applied with AND logic. Each filter object has three fields: - "attribute": one of the supported filter attributes listed below. - "operator": comparison operator (must be valid for the attribute's data type — see below). - "value": list of string values. Rules: - For "is" operator: multiple values use OR logic (e.g. ["42", "43"]). - For "between" operator: exactly two values — [min, max] (e.g. ["2026-01-01T00:00:00Z", "2026-06-30T23:59:59Z"]). - For relative-date operators (today, thisWeek, nextWeek, todayAndLater): value MUST be a one-item list containing the user's current timezone offset in hours as a string (e.g. ["-7"] for UTC-7, ["5.5"] for UTC+5:30). This offset is required so the backend returns accurate results for the user's local date/time. CRITICAL RULES: - ONLY use the exact attribute names and operators listed in the tables below. - NEVER invent, guess, or fabricate any attribute or operator not listed here. - There is NO "userId" attribute. To filter by user, use attribute "users" with the user's ID. - If an attribute is not listed below, DO NOT use it. Supported filter attributes by type: DATE (value operators: is, between; relative-date operators require value = ["{timezoneOffsetInHours}"]: today, yesterday, tomorrow, todayAndLater, untilToday, thisWeek, last7Days): - startTime BOOLEAN (operators: is): - canceled REFERENCE (operators: is; values are IDs of the associated object, e.g. prospect ID, account ID, opportunity ID): - prospectId, accountId, opportunityId, attributedSequenceId, users (filter by user ID) ALWAYS: - exclude canceled calendar events unless user explicitly asks for canceled events: {attribute: "canceled", operator: "is", value: ["false"]} - include an opportunityId or accountId filter if a specific account or opportunity of interest is indicated in the conversation. Examples: [ {attribute: "users", operator: "is", value: ["42"]}, {attribute: "canceled", operator: "is", value: ["false"]} ] --> non-canceled events on calendars owned by user 42 [ {attribute: "startTime", operator: "todayAndLater", value: ["-7"]}, {attribute: "opportunityId", operator: "is", value: ["123"]} ] --> upcoming meetings from today onward for opportunity 123 (user is in UTC-7) [ {attribute: "startTime", operator: "between", value: ["2026-03-06T00:00:00Z", "2026-03-20T23:59:59Z"]} ] --> meetings scheduled between March 6 and March 20, 2026 [ {attribute: "prospectId", operator: "is", value: ["456"]}, {attribute: "canceled", operator: "is", value: ["false"]} ] --> non-canceled meetings associated with prospect 456 [ {attribute: "attributedSequenceId", operator: "is", value: ["789"]} ] --> meetings attributed to sequence 789

Maximum number of calendar events to return per page. Valid range 1-30.

Pagination offset used for fetching calendar events.

The attribute to sort results by. ONLY Supported attributes: - 'startTime' Examples: 'startTime' --> sort by event start date in ascending order (earliest to latest) '-startTime' --> sort by event start date in descending order (latest to earliest)

Filter search results to emails associated with this account_id. REQUIRED: Either account_id OR opportunity_id must be provided (not both). If filtering by opportunity instead, leave this null.

Optional. Only return mailings delivered after this time. Use with state='delivered'.

Optional. Only return mailings delivered before this time. Use with state='delivered'.

If true, includes the abbreviated email body in the response.

If true, includes the email subject line in the response.

Maximum number of mailings to return.

Pagination offset used for fetching mailings.

Optional. Only return mailings opened after this time. Use with state='opened'.

Optional. Only return mailings opened before this time. Use with state='opened'.

Filter search results to emails associated with this opportunity_id. REQUIRED: Either account_id OR opportunity_id must be provided (not both). If filtering by account instead, leave this null.

Optional. Only return mailings replied after this time. Use with state='replied'.

Optional. Only return mailings replied before this time. Use with state='replied'.

Filter by email state. If not supplied, defaults to 'delivered'. States are progressive: opened and replied are subsets of delivered. Use 'delivered' for all sent emails (pair with delivered_at_after/before). Use 'opened' for delivered emails that were opened (pair with opened_at_after/before). Use 'replied' for delivered emails that got a reply (pair with replied_at_after/before). Only use the time filter that matches the state — e.g. opened_at has no effect with state='delivered'.

Filter emails to those sent or received by this user. Use this when a user asks about their own emails or emails for a specific user.

Entity type to fetch fields for

Action type (e.g. 'Create', 'Update').

Resource type to fetch input fields for (e.g. 'Account', 'Prospect', 'Opportunity').

Pagination cursor. Pass the end_cursor from a previous response to fetch the next page.

JSON list of filter objects. Each object has 'attribute' (str), 'value' (list of str), and optional 'operator' (str, defaults to "is"). See tool description for supported attributes and examples.

Maximum number of meetings to return per page. Valid range 1-30.

Controls which artifact types are returned per meeting. List of objects with 'attribute' ("transcript" or "topic") and 'includeType' ("matching" or "full"). Example: [{"attribute": "transcript", "includeType": "matching"}]

Whether to include the recording summary for each meeting. Defaults to false.

Maximum number of matching artifacts returned per meeting per include type. Defaults to 20. Increase if more matching transcript segments or topics are needed per meeting.

ID of an opportunity. Must be a positive integer.

A specific question about the opportunity to ask. Cannot be an empty string.

An optional end date to filter the opportunity data.

An optional start date to filter the opportunity data.

Input model containing opportunity creation details. All values MUST come directly from the user. Never guess or fabricate any field value. ALWAYS call input_fields_fetch first to discover available additional fields and their types.

ID of an opportunity (not an account ID or prospect ID). Must be a positive integer. Get this from opportunity_search results or conversation context.

When true, fetches sales methodology field definitions and populates the sales_methodology field on the returned Opportunity with each active field's value for this opportunity.

Filter by account ID to find all opportunities in a specific account

Optional list of additional field filters applied with AND logic alongside the named parameters above. Each filter must include: - "attribute": field id from filter_fields_fetch (ex. "custom8" or "mapStatus") - "value": list of filter values (always strings). For operator "is": multiple values match with OR logic (ex. ["High", "Medium"]). For all other operators: provide a single value in the list (ex. ["1000000"] or ["salient seller"]). - "operator": what function to perform on "value" to produce search results (ex. "is") Allowed operators by field validation_type: - "string": is, contains, startswith - "inclusion": is - "numerical": gte, lte, is - "currency": gte, lte, is Operator definitions: - "gte": matches fields greater than or equal to Filter.value - "lte": matches fields less than or equal to Filter.value - "is": matches exact string equality between field and Filter.value - "contains": matches fields that contain Filter.value as a substring - "startswith": matches fields that start with Filter.value Rules: - For filter fields with validation_type of "inclusion", use values exactly as returned in validation_definition (case-sensitive).

Additional fields to include in the output. Only accepts field IDs discovered via `filter_fields_fetch` (e.g. "custom8" or "mapStatus"). Only pick fields needed to answer the user's query. Example: - "What is the forecast category for these opportunities?" → call `filter_fields_fetch` tool to get [..., {"id": "custom5", "label": "Forecast Category"}, ...] → ["custom5"]

Optional. Only return opportunity close_date after this time. If only close_date_after is provided without close_date_before, the search will return opportunities close_date in 90 days after close_date_after.

Optional. Only return opportunity close_date before this time. If only close_date_before is provided without close_date_after, the search will return opportunities close_date in 90 days before close_date_before.

Optional. Only return opportunity created after this time. If only created_after is provided without created_before, the search will return opportunities created in 90 days after created_after.

Optional. Only return opportunity created before this time. If only created_before is provided without created_after, the search will return opportunities created in 90 days before created_before.

Optional. Upper bound of health score range filter (0-100 inclusive). If only health_score_high is provided without health_score_low, health_score_low defaults to 0.

Optional. Lower bound of health score range filter (0-100 inclusive). If only health_score_low is provided without health_score_high, health_score_high defaults to 100.

Filter by a list of opportunity IDs. Returns only opportunities whose ID is in this list.

if true, only return open opportunities. if false, only return closed opportunities. if null, return both open and closed opportunities.

Maximum number of opportunities to return.

full name or partial opportunity name to search. Cannot be an empty string.

Pagination offset used for fetching opportunities.

Filter by a list of user IDs. Returns only opportunities owned by users whose IDs are in this list.

List of fields to sort by. The supported fields are: "created_at", "last_contacted_at", "amount", "health_score", "close_date". Each field should be in the format "-field" for descending order or "field" for ascending order. Only one sort field is allowed for each call.

ID of the associated object in external systems to search. Cannot be an empty string.

Filter criteria to narrow down results by specific field values. - Supported attributes: 'id', 'name', 'isClosed' - Only exact matches are supported for 'name' - Multiple filters are combined with AND logic Example: filter: [ {attribute: "isClosed", "operator": "is", value: "true"}, {attribute: "id", "operator": "is", value: ["27"]} ]

Maximum number of opportunity stages to return. Valid range 1-30.

Pagination offset used for fetching opportunity stages.

Input model containing prospect creation details. Standard optional fields (title, company, emails, etc.) are declared directly on this model. CRITICAL: Populate `additional_fields` FIRST with all user-provided custom field values and all required fields from `input_fields_fetch` BEFORE setting any other fields to null. Custom fields (custom1, custom2, etc.) MUST go inside `additional_fields` as key-value string pairs — NEVER as top-level fields. Example: additional_fields: [{field_name: "custom1", value: "Google"}].

ID of a prospect (not an account ID, opportunity ID, or user ID). Must be a positive integer. Common sources: any tool result that returns a prospect object (prospect.id field), conversation context, or injected context from the UI.

Filter by a list of account IDs. Returns only prospects whose account ID is in this list.

Optional list of additional field filters applied with AND logic alongside the named parameters above. Each filter object has three fields: - "attribute": field id from filter_fields_fetch (e.g. "custom8", "engagedAt"). - "operator": comparison operator (must be valid for the attribute's data type — see below). - "value": list of string values. Rules: - For "is" operator: multiple values use OR logic (e.g. ["High", "Medium"]). - For "between" operator: exactly two values — [min, max] (e.g. ["1", "100"] or ["2025-01-01", "2025-06-30"]). - For all other value-taking operators: a single value in the list (e.g. ["1000000"]). - For no-value operators (isEmpty, isNotEmpty, and all relative-date operators like today, last7Days, etc.): provide an empty list []. ═══════════════════════════════════════════════════════════════════════ CUSTOM FIELDS (from filter_fields_fetch) ═══════════════════════════════════════════════════════════════════════ For custom fields (e.g. "custom1", "custom8") and standard fields returned by filter_fields_fetch, use the "validation_type" from the response to determine which operators are allowed: validation_type "string": Operators: is, isNot, startsWith, contains, notContains, isEmpty, isNotEmpty Example: {"attribute": "custom5", "operator": "contains", "value": ["enterprise"]} validation_type "numerical" or "currency": Operators: is, isNot, between, gte, lte, isEmpty, isNotEmpty Example: {"attribute": "custom1", "operator": "gte", "value": ["1000000"]} validation_type "date": Value operators: is, between, gte, lte, isEmpty, isNotEmpty Relative-date operators (value = []): today, yesterday, tomorrow, beforeToday, todayAndLater, untilToday, until90Days, last7Days, last30Days, last90Days, next7Days, next30Days, next90Days, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, ytd Example: {"attribute": "custom12", "operator": "last30Days", "value": []} validation_type "boolean": Operators: is, isNot, isEmpty, isNotEmpty Example: {"attribute": "custom3", "operator": "is", "value": ["true"]} validation_type "inclusion" or "multi_inclusion": Operators: is, isNot, isEmpty, isNotEmpty Values MUST exactly match entries from validation_definition (case-sensitive). Example: {"attribute": "custom8", "operator": "is", "value": ["High", "Medium"]} ═══════════════════════════════════════════════════════════════════════ STANDARD FIELDS (not from filter_fields_fetch) ═══════════════════════════════════════════════════════════════════════ The following standard fields are NOT returned by filter_fields_fetch but can be used directly as filter attributes. Use the operators listed for each data type. ┌─────────────────────────────────────────────────────────────────────┐ │ STRING type │ │ Operators: is, isNot, startsWith, contains, notContains, │ │ isEmpty, isNotEmpty │ ├─────────────────────────────────────────────────────────────────────┤ │ email, addressState, addressStreet, addressStreet2, addressCity, │ │ addressZip, addressCountry, campaignName, companyIndustry, │ │ companyLinkedIn, companyLocality, companyNatural, companyType, │ │ currentSequenceStatus, currentSequenceStep, │ │ currentSequenceStepType, currentSequenceUserName, eventName, │ │ externalId, externalOwner, externalSource, finishedSequence, │ │ firstName, fullName, homePhone, integrationRecordType, lastName, │ │ linkedIn, linkedInId, middleName, mobilePhone, otherPhone, │ │ personalNote1, personalNote2, preferredContact, │ │ opportunityProspectRole, timeZone, twitterUsername, voipPhone, │ │ workPhone, lastEnrichmentStatus, phoneStatuses, emailStatuses, │ │ skills, interests │ └─────────────────────────────────────────────────────────────────────┘ ┌─────────────────────────────────────────────────────────────────────┐ │ NUMBER type │ │ Operators: is, isNot, between, gte, lte, isEmpty, isNotEmpty │ ├─────────────────────────────────────────────────────────────────────┤ │ numActiveSequences, activeTaskCount, companyFollowers, │ │ companyLinkedInEmployees, companySize, engagedScore, │ │ linkedInConnections, numBookedMeetings │ └─────────────────────────────────────────────────────────────────────┘ ┌─────────────────────────────────────────────────────────────────────┐ │ DATE type │ │ Value operators: is, between, gte, lte, isEmpty, isNotEmpty │ │ Relative-date operators (value = []): │ │ today, yesterday, tomorrow, beforeToday, todayAndLater, │ │ untilToday, until90Days, last7Days, last30Days, last90Days, │ │ next7Days, next30Days, next90Days, lastWeek, thisWeek, nextWeek, │ │ lastMonth, thisMonth, ytd │ ├─────────────────────────────────────────────────────────────────────┤ │ createdAt, currentSequenceStepDue, engagedAt, touchedAt, updatedAt, │ │ availableAt, optedOutAt, enrichedAt, lastEnrichmentUpdatedAt, │ │ enrichableSetAt, signalsEventAt, workHistoryStartDate │ └─────────────────────────────────────────────────────────────────────┘ ┌─────────────────────────────────────────────────────────────────────┐ │ ID-LIKE type │ │ Operators: is, isNot, isEmpty, isNotEmpty │ ├─────────────────────────────────────────────────────────────────────┤ │ activeSequence │ └─────────────────────────────────────────────────────────────────────┘ Rules: - Always call `filter_fields_fetch` with entity_type="prospect" first to discover custom field IDs. Never guess field IDs. - For custom fields: match the validation_type from filter_fields_fetch to the operator table above. - For standard fields: use the hardcoded attribute lists above directly. - For fields with validation_type "inclusion" or "multi_inclusion": values must exactly match entries from validation_definition (case-sensitive).

Additional fields to include in the output. Only accepts field IDs discovered via `filter_fields_fetch` (e.g. "custom8"). Only pick fields needed to answer the user's query.

Filter by a list of prospect IDs. Returns only prospects whose ID is in this list.

Maximum number of prospects to return.

Full or partial prospect name to search. Cannot be an empty string. Do not pass null to retrieve all prospects.

Pagination offset used for fetching prospects.

Filter by a list of opportunity IDs. Returns only prospects associated with the given opportunity IDs.

Filter by a list of owner IDs. Returns only prospects whose owner ID is in this list.

ID of the associated object in external systems to search. Cannot be an empty string.

Input model containing the prospect IDs, sequence ID, and optional configuration for the add-to-sequence operation.

Optional list of field filters applied with AND logic. Each filter object has three fields: - "attribute": field identifier (see supported fields below). - "operator": comparison operator (must be valid for the attribute's data type — see below). - "value": list of string values. - For "is" operator: multiple values use OR logic (e.g. ["active", "paused"]). IMPORTANT: Use `favoritedBy` filter with the user's ID to find `my favorite sequences`, `Joe's favorite sequences`, etc. Supported filter attributes by type: DATE (operators: is, between, today, yesterday, tomorrow, todayAndLater, untilToday, thisWeek, last7Days; for relative operators, value is ["{timezoneOffsetInHours}"]): - createdAt, lastUsedAt, updatedAt STRING ENUM (operators: is): - salesMotion: SequenceSalesMotion enum values - type: "interval", "date" - shareType: "shared", "read_only", "private" - state: "active", "inactive", "locked", "paused" ENGAGEMENT SCORE (operator: between; value is a range, e.g. ["0", "25"]): - engagementScore STRING FREE TEXT (operators: is, contains; feature-flag gated): - name BOOLEAN (operators: is; value is ["true"] or ["false"]): - ownedByLockedUsers, aiTemplatePowered, transactional NUMBER (operators: is, between): - interestedCount, prospectContactedCount, prospectDeliverCount REFERENCE (operators: is; values are IDs of the associated object): - contentCategory (ContentCategory), owner (User), favoritedBy (User), tags (Tag), ruleset (Ruleset), scheduleId (SequenceSchedule), team (Team)

Cursor for fetching the next page of results. Use the value of page_info.end_cursor from a previous response.

Maximum number of sequences to return per page.

Optional list of sort attributes. Prefix with "-" for descending order. Supported sort keys: recent, createdAt, updatedAt, name, owner, scheduleName, rulesetName, deliveries, replies, opens, clicks, interestedCount, engagementScore.

Optional list of field filters applied with AND logic. Each filter object has three fields: - "attribute": field identifier (see supported fields below). - "operator": comparison operator (must be valid for the attribute's data type — see below). - "value": list of string values. - For "is" operator: multiple values use OR logic (e.g. ["1", "2"]). IMPORTANT: To filter by multiple values, pass ALL values in a single filter's "value" list. Do NOT make separate calls for each value. Supported filter attributes: REFERENCE (operators: is, isNot, isEmpty, isNotEmpty; value MUST be a list of IDs): - accounts: filter by account IDs. Example: {"attribute": "accounts", "operator": "is", "value": ["123", "456"]} - prospects: filter by prospect IDs. Example: {"attribute": "prospects", "operator": "is", "value": ["789"]} - opportunities: filter by opportunity IDs. Example: {"attribute": "opportunities", "operator": "is", "value": ["101"]} STATE (operators: is, isNot; value is a list of state strings): - state: filter by sequence state. Example: {"attribute": "state", "operator": "is", "value": ["active", "paused"]} There are two categories of state values: Persisted states (stored directly on the sequence-state record): "pending" : not yet activated due to throttles, errors, or scheduling constraints "active" : currently being worked through steps "paused" : temporarily halted; can be resumed "disabled" : turned off by a user or system rule "failed" : delivery or processing failure "bounced" : email bounced "opted_out" : prospect unsubscribed / opted out "finished" : all steps completed Derived filters (query against stat counters or timestamps, not the state column; can overlap with any persisted state): "delivered" : at least one delivery and not bounced (deliver_count > 0 AND state != 'bounced') "opened" : at least one email open (open_count > 0) "clicked" : at least one link click (click_count > 0) "replied" : prospect replied (replied_at IS NOT NULL) "called" : at least one call attempted (call_completed_count > 0 OR call_no_answer_count > 0) "no_reply" : finished without a reply (state = 'finished' AND replied_at IS NULL) "contacted" : delivered or called (union of both conditions) Persisted and derived filters may be combined in the same list. Because derived filters check counters/timestamps rather than the state column, a prospect can match a derived filter while being in any persisted state (e.g., "active" and "opened" at the same time). Common synonyms: "running" / "in progress" / "currently active" → "active" "completed" / "stopped" / "inactive" / "no longer running" → ["failed", "opted_out", "finished", "bounced"] "engaged" / "interacted" → ["opened", "clicked", "replied"] For "isEmpty"/"isNotEmpty": value should be an empty list [].

Maximum number of sequence states to return.

Pagination offset used for fetching sequence states.

Maximum number of stages to return. Valid range 1-30.

Pagination offset used for fetching stages.

ID of a user (not an account ID, opportunity ID, or prospect ID). Must be a positive integer. Get this from user_search results, opportunity.owner.id, or account.owner.id.

Optional list of additional field filters applied with AND logic alongside the named parameters above. Each filter object has three fields: - "attribute": field identifier (see supported fields below). - "operator": comparison operator (must be valid for the attribute's data type — see below). - "value": list of string values. - For "is" operator: multiple values use OR logic (e.g. ["admin", "manager"]). IMPORTANT: To filter by multiple values, pass ALL values in a single filter's "value" list. Do NOT make separate calls for each value. Use `favoritedBy` filter to find `my favorite users`, `Joe's favorite users`, etc. MUST use the user's ID as the value. Supported filter attributes by type: REFERENCE (operators: is; value MUST be a list of IDs of the corresponding type — pass ALL IDs in one call): - team, profile, governanceRole, jobRole, favoritedBy (User) BOOLEAN (operators: is; value = ["true"] or ["false"]): - "locked": filter by locked status. Defaults to false if not provided. Example: {"attribute": "locked", "operator": "is", "value": ["true"]} - "guest": filter by guest status. Defaults to false if not provided. Example: {"attribute": "guest", "operator": "is", "value": ["true"]} NUMBER (operators: is; value is a list of numeric strings): - minProspectCount DATE (operators: is, between, gte, lte, null, notnull; value must be ISO datetime e.g. "YYYY-MM-DDTHH:MM:SSZ"): - currentSignInAt For "between": value = ["<start>", "<end>"] For "null"/"notnull": value = ["<any valid datetime>"] (value is ignored but must be valid datetime format) Example: {"attribute": "currentSignInAt", "operator": "gte", "value": ["2024-01-01T00:00:00Z"]} STRING ENUM (operators: is): - calendarSyncState: values "true", "false" Example: {"attribute": "calendarSyncState", "operator": "is", "value": ["true"]} SPECIAL / CONTROLLER-LEVEL (operators: is): - email: user email address

Filter by a list of user IDs. Returns only users whose ID is in this list.

Maximum number of users to return.

Full or partial user name to search. Cannot be an empty string.

Pagination offset used for fetching users.