Outfield

Load structured account deals with orders and line items for AI summarization. Use a contact_id from search_contacts (typically an account/place). Returns deals where that contact is the deal account. Returns up to 25 deals per call, newest updated first. If meta.has_more is true, you can call again with cursor set to meta.next_cursor to fetch the next older page if appropriate. You can repeat until meta.has_more is false to retrieve the full deals history, but more than the first page is not necessary if you were prompted to summarize recent deals for example.

get_contact_deals

Load all structured details for an accessible Outfield place or person (i.e. account/contact), including contact information, custom fields, default fields, images, activity timestamps, contact goals with progress, and up to 500 linked contacts. Use search_contacts first to resolve an unambiguous contact ID. Contact IDs work across organizations the user belongs to.

get_contact_detail

Load deal pipeline stages, catalog discounts, taxes, payment terms, and the calling user's deal-creation permissions. Call this before create_deal to choose deal_status_id, discount_id, tax_id, and to know whether the user can override prices, add one-off line items, or assign the deal to another user. Discounts with applies_to "order" belong on the order; "line_item" belong on a line item; "both" can be used in either place. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_deal_options

Load structured details for an accessible Outfield form, including every form field, choices, options, ordering, KPI settings, and conditional field relationships. Every form can be attached to check-ins, meetings, phone calls, and calendar events. Use field ids and field_type rules when filling form_entries on create_check_in, create_meeting, or create_phone_call. Use get_forms first to resolve a form ID. Form IDs work across organizations the user belongs to.

get_form_detail

List the current active version of accessible Outfield forms, including each form's ID, title, required status, creation date, and field count. Every listed form can be attached to check-ins, meetings, phone calls, and calendar events. Honor is_required forms and meta.min_forms_required_per_interaction (check-ins and meetings) or meta.min_forms_required_per_phone_call (phone calls) when logging those interactions. Returns up to 50 forms per call, alphabetically by title. When meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page. Use a returned form ID with get_form_detail to inspect its fields and conditions. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to list the current organization.

get_forms

Load active product-variant inventory, including the variant id, the primary product_variant_price id, SKU, available and on-hand quantities, pricing, and case size. Use product_variant_price.id as product_variant_price_id when calling create_deal. Quantity on a deal line item is in cases when case_size is greater than 1; quantity_available is in single units. Additional prices on the same variant appear in additional_product_variant_prices. Use query to locate a product by product name, variant label, SKU, or other indexed product details. Returns up to 50 variants per call, newest first. If meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next older page if appropriate. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_inventory

Load structured team/organization activity for AI summarization. Use this when the user asks about their team's activity (for example, "What has my team's activity been like this week?"). For a single team member's activity, use get_user_activity instead. Returns up to 50 interactions per call, newest first. Pass start_date and end_date as an ISO date or datetime pair when the user names a time window such as this week. If the user names a form, call get_forms first and pass matching form IDs as form_ids; that includes interactions tagged with any version in each form's ancestry. If meta.has_more is true, you can call again with cursor set to meta.next_cursor to fetch the next older page if appropriate. You can repeat until meta.has_more is false to retrieve the full activity history, but more than the first page is not necessary if you were prompted to summarize recent activity for example. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_org_activity

Load structured team/organization deals with orders and line items for AI summarization. Use this when the user asks about their team's deals (for example, "How are my team's deals looking this month?"). For a single team member's deals, use get_user_deals instead. Returns up to 25 deals per call, newest updated first. Pass start_date and end_date as an ISO date or datetime pair when the user names a time window such as this month; dates filter deals by updated_at. Use query to search deal name, notes, account, and related text. If meta.has_more is true, you can call again with cursor set to meta.next_cursor to fetch the next older page if appropriate. You can repeat until meta.has_more is false to retrieve the full deals history, but more than the first page is not necessary if you were prompted to summarize recent deals for example. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_org_deals

List performance roles and their leagues (gold/silver/bronze leaderboards) for the current user's enterprise. Each role includes id, name, and is_my_performance_role. Nested leagues include id, name, first_quarter_date, and is_my_league. Nested reward_pools include id, name, cadence, and pool_type. Use is_my_performance_role and is_my_league to answer "Which league am I in?" or "What is my performance role?". Pass a returned league id to get_user_matchups as league_id to load only that league's matchups, to get_user_leaderboards as league_id to rank that league by total performance points, or to get_user_calendar_quarter_rankings as league_id for that league's Standings. Pass a returned reward pool id to get_user_reward_pool_credit_rankings as pool_id; use cadence to choose the right pool for a period (monthly + period_offset 1 for last month). Users with only_my_performance_role see only their own role; others see all non-deleted roles in the enterprise.

get_performance_roles_and_leaderboards

Load product variant price kits for creating deal line items. Use kit id as product_variant_price_kit_id in create_deal. Kit quantity_available is the number of complete kits that can be sold from component stock. Returns up to 50 kits per call, newest first. If meta.has_more is true, call again with cursor set to meta.next_cursor. Use query to match kit name or description. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_product_kits

Load structured team-member activity for AI summarization. Returns up to 50 interactions per call, newest first. When the user asks for "my activity", omit user_id to load the authenticated user's activity. If meta.has_more is true, you can call again with cursor set to meta.next_cursor to fetch the next older page if appropriate. You can repeat until meta.has_more is false to retrieve the full activity history, but more than the first page is not necessary if you were prompted to summarize recent activity for example. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_user_activity

Load structured scheduled calendar events for a team member. When the user asks for "my calendar events", omit user_id to load the authenticated user's events. Pass user_id only when they ask about another team member. By default, only current and upcoming incomplete events are returned (from the start of today onward), soonest first, up to 50 per call. Pass start_date and end_date together to include historical ranges or answer questions such as calendar events this week. If meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page if appropriate. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_user_calendar_events

Rank active user teams in league Standings by win/loss/tie record for a calendar quarter (the same ranking as the Standings UI). This is not the points leaderboard; use get_user_leaderboards for total performance points. Standings are always for a single league: omit league_id so the requester defaults to their own league. There are no global standings; if the user has no league, the response is empty and explains why. Pass league_id from get_performance_roles_and_leaderboards to inspect another allowed league. Omit calendar_quarter_date for the current quarter; pass an ISO date in another quarter to rank that season. Returns up to 25 teams per call. meta.my_team always includes the requester's team id, rank, points value, and win/loss/tie record even when that team is not on the current page. When meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page.

get_user_calendar_quarter_rankings

Load structured deals with orders and line items for a team member. Use this when the user asks about their deals (for example, "How are my deals looking?"). When the user asks for "my deals", omit user_id to load the authenticated user's deals. For a named teammate, call search_users first and pass that id as user_id. For team or organization-wide deals, use get_org_deals instead. Returns up to 25 deals per call, newest updated first. Pass start_date and end_date as an ISO date or datetime pair when the user names a time window such as this month; dates filter deals by updated_at. Use query to search deal name, notes, account, and related text. If meta.has_more is true, you can call again with cursor set to meta.next_cursor to fetch the next older page if appropriate. You can repeat until meta.has_more is false to retrieve the full deals history, but more than the first page is not necessary if you were prompted to summarize recent deals for example. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_user_deals

Load an accessible team member goal with progress for its 12 most recent configured periods. Use get_user_goals first to identify the goal ID. Omit user_id for your own goals; only admins may request another team member. Omit end_period for the current period; provide an ISO date to end the history at the goal period containing that date. One-time goals return one progress value for their full created-at-through-due-date period. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_user_goal_detail

Load structured individual and combined goals for a team member, including progress for the goal period containing period_date. Omit period_date for the current period. For example, pass a date from last week to load weekly-goal progress for last week. When the user asks about "my goals", omit user_id to load the authenticated user's goals. Pass user_id only when an admin asks about another team member. Goals are returned in configured order, up to 50 per call. If meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page. Use query to find a goal by name and goal_type to restrict results to individual or combined goals. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_user_goals

Load structured incomplete tasks for a team member. When the user asks for "my tasks", omit user_id to load the authenticated user's tasks. Pass user_id only when they ask about another team member. Tasks are returned soonest first, up to 50 per call. If meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page if appropriate. Use start_date and end_date together to answer questions such as tasks due this week. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_user_incomplete_tasks

Rank active user teams by total performance points for a date range. Omit start_date and end_date to rank the current week; pass both dates (for example the first and last day of this month) for another inclusive range. Pass league_id from get_performance_roles_and_leaderboards to rank a single league; omit it so users default to their own league and admins default to all enterprise leagues unless they have only_my_performance_role, in which case they also default to their own league. Returns up to 25 teams per call, ordered by total points. meta.my_team always includes the requester's team id, rank, and value even when that team is not on the current page. When meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page. This tool does not support other leaderboard metrics such as check-in counts, point categories, goals, shadows, or all-time records.

get_user_leaderboards

Load a user's current or historical league-play matchup with points, KPIs, and daily hustle/diligence/preparation/leadership totals. Use get_user_matchups first when the user asks about matchups in general (for example, "How are the matchups looking this week?"). Omit user_id when the user asks about their own matchup (for example, "How am I doing in my current matchup?"). Pass user_id for another teammate in the same performance-role leagues; admins may load any enterprise performance-role matchup unless they have only_my_performance_role. Omit matchup_date for today's matchup; pass an ISO date to select the matchup whose started_at/ended_at window contains that date.

get_user_matchup_detail

List league-play matchups for the current week (or a given date), including each matchup's league, performance role, teams, points, and nested user names. User roles see matchups in their performance-role leagues; admins see all enterprise leagues unless they have only_my_performance_role, in which case they see only their role. Omit matchup_date for today's matchups; pass an ISO date to select matchups whose started_at/ended_at window contains that date. Pass league_id from get_performance_roles_and_leaderboards to return only that league's matchups; omit it to keep the default league set. Returns up to 15 matchups per call, ordered by matchup ID. When meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page. Use a nested user ID with get_user_matchup_detail for KPIs and daily hustle/diligence/preparation/leadership totals.

get_user_matchups

Load point totals by configured performance action for a user over a date range. Omit user_id when the user asks about their own performance. Pass user_id only when an admin asks about another user. Omit start_date and end_date to summarize the current week; otherwise, pass both dates to select an inclusive date range. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to use the current organization.

get_user_performance

Load the authenticated user's profile and organization memberships. Call this first when the user names a team or organization, or to list the organizations they can query. Use a returned organization id as organization_id on search and list tools (search_contacts, search_users, get_forms, get_inventory, get_org_activity, get_user_activity, get_user_incomplete_tasks, get_user_calendar_events, get_user_goals, get_user_performance, get_user_goal_detail). Omit organization_id on those tools to use current_organization. Does not change the user's selected organization.

get_user_profile

Rank users in a Reward Pool by estimated or distributed reward credits. This is the same ranking as Reward Pools in League Play. Omit pool_id and period_offset to rank the requester's current default pool (the first active pool on their performance role) for the current period. Pass pool_id from get_performance_roles_and_leaderboards to rank a specific pool. period_offset is relative to the selected pool's cadence, not calendar months: 0 is the current in-progress period, 1 is the previous complete period. To answer "last month", choose a monthly pool from get_performance_roles_and_leaderboards (prefer is_my_performance_role) and pass period_offset 1. Users with only_my_performance_role can only rank pools on their own role; unrestricted admins can rank any enterprise pool they can see. Returns up to 25 users per call, ordered by estimated credits. meta.my_user always includes the requester's id, rank, eligible_points, share_percent, and estimated_credits even when that user is not on the current page. When meta.has_more is true, call again with cursor set to meta.next_cursor to fetch the next page.

get_user_reward_pool_credit_rankings

Health check; returns authenticated user and organization context

ping

Search accessible Outfield accounts and people by name, company, address, email, phone, or other contact data. When order_by is supplied, query may be omitted to browse accessible contacts. Valid order_by values are created_at, last_interaction_at (last activity; not last_activity_at), last_touchpoint_at, last_check_in_at, last_onsite_check_in_at, last_meeting_at, last_phone_call_at, last_text_message_at, last_email_at, last_progressed_deal_at, last_revenue_deal_at, and last_form_completed_ats. Use last_form_completed_ats only with root_form_id from get_forms. For example, to find accounts last checked in with 1 to 4 weeks ago, use contact_type=place, order_by=last_check_in_at, start_date, and end_date. Use cursor=meta.next_cursor to continue through additional pages while meta.has_more is true. Use a returned contact id as contact_id for get_contact_detail, get_contact_activity, or get_contact_deals. If multiple contacts could match, ask the user to clarify before loading details, activity, or deals. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to search the current organization.

search_contacts

Search accessible Outfield team members by name, title, role, email, or other profile data. Use a returned user id as user_id for get_user_activity. Admins can also use it for get_user_goals; non-admins can load only their own goals. If multiple users could match, ask the user to clarify before loading activity or goals. If the user names a team, call get_user_profile first and pass organization_id. Omit organization_id to search the current organization.

search_users