Authenticated FieldRobin workspace tools, including scope-authorized customer and job creation.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Lists complaint and recall risk records for the authenticated workspace without exposing private operational notes.
Maximum records to return.
Job title, customer name, or technician name.
Risk state; defaults to open.
Lists complaint and recall risk records for the authenticated workspace without exposing private operational notes.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum records to return. |
| query | string | null | Job title, customer name, or technician name. |
| status | string | null | Risk state; defaults to open. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum records to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Job title, customer name, or technician name."
},
"status": {
"enum": [
"open",
"resolved",
"all"
],
"type": [
"string",
"null"
],
"description": "Risk state; defaults to open."
}
}
}Creates one customer directly in the selected FieldRobin business when the connection has customer-write permission. Search first to avoid creating a duplicate; reuse the idempotency key only when retrying the same request.
| Argument | Type | Description |
|---|---|---|
| name* | string | Customer full name. |
| string | null | Customer email address, if known. | |
| notes | string | null | Internal customer notes. |
| phone | string | null | Customer phone number, if known. |
| address | string | null | Customer address, if known. |
| trade_type | string | null | Customer trade or service type. |
| location_id | integer | null | Business location for the customer. |
| business_name | string | null | Customer business name, if known. |
| lifecycle_tag | string | null | Lifecycle tag. |
| idempotency_key* | string | Opaque retry key. Reuse it only for the same request to receive the verified result without creating a duplicate. |
| acquisition_source | string | null | How the customer was acquired. |
{
"type": "object",
"required": [
"name",
"idempotency_key"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Customer full name."
},
"email": {
"type": [
"string",
"null"
],
"format": "email",
"maxLength": 255,
"description": "Customer email address, if known."
},
"notes": {
"type": [
"string",
"null"
],
"description": "Internal customer notes."
},
"phone": {
"type": [
"string",
"null"
],
"maxLength": 30,
"description": "Customer phone number, if known."
},
"address": {
"type": [
"string",
"null"
],
"maxLength": 500,
"description": "Customer address, if known."
},
"trade_type": {
"type": [
"string",
"null"
],
"maxLength": 100,
"description": "Customer trade or service type."
},
"location_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Business location for the customer."
},
"business_name": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Customer business name, if known."
},
"lifecycle_tag": {
"enum": [
"active",
"inactive",
"vip"
],
"type": [
"string",
"null"
],
"description": "Lifecycle tag."
},
"idempotency_key": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Opaque retry key. Reuse it only for the same request to receive the verified result without creating a duplicate."
},
"acquisition_source": {
"type": [
"string",
"null"
],
"maxLength": 100,
"description": "How the customer was acquired."
}
}
}Creates one job directly in the selected FieldRobin business when the connection has job-write permission. Resolve the customer first and pass the verified customer ID when one is named.
| Argument | Type | Description |
|---|---|---|
| title* | string | Short job title. |
| status | string | null | Initial job status. |
| customer_id | integer | null | Verified customer ID, if the job belongs to an existing customer. |
| description | string | null | Readable issue and service description. |
| location_id | integer | null | Business location for the job. |
| voice_notes | string | null | Optional internal voice-note text. |
| scheduled_at | string | null | Optional local wall-clock appointment date/time or ISO timestamp with offset. |
| total_amount | number | null | Optional quoted amount. |
| idempotency_key* | string | Opaque retry key. Reuse it only for the same request to receive the verified result without creating a duplicate. |
Lists recent active service requests associated with one authorized customer using bounded status, source, urgency, and scheduling fields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of service requests to return. |
| customer_id | integer | Customer ID returned by search-customers. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of service requests to return."
},
"customer_id": {
"type": "integer",
"minimum": 1,
"description": "Customer ID returned by search-customers."
}
}
}Drafts a policy-aware reply for one authorized review without posting or changing the review.
| Argument | Type | Description |
|---|---|---|
| tone | string | null | Draft tone. |
| review_id | integer | Review ID returned by search-reviews. |
{
"type": "object",
"properties": {
"tone": {
"enum": [
"professional",
"warm",
"concise"
],
"type": [
"string",
"null"
],
"description": "Draft tone."
},
"review_id": {
"type": "integer",
"minimum": 1,
"description": "Review ID returned by search-reviews."
}
}
}Returns one authorized customer using bounded contact and lifecycle fields; addresses and notes are excluded.
| Argument | Type | Description |
|---|---|---|
| customer_id | integer | Customer ID returned by search-customers. |
{
"type": "object",
"properties": {
"customer_id": {
"type": "integer",
"minimum": 1,
"description": "Customer ID returned by search-customers."
}
}
}Returns one authorized invoice with bounded customer, job, payment-state, due-date, and line-item fields; payment links, addresses, and internal notes are excluded.
| Argument | Type | Description |
|---|---|---|
| invoice_id | integer | Invoice ID returned by search-invoices. |
{
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"minimum": 1,
"description": "Invoice ID returned by search-invoices."
}
}
}Returns the authoritative payment state for one authorized invoice without exposing payment links or provider identifiers.
| Argument | Type | Description |
|---|---|---|
| invoice_id | integer | Invoice ID returned by search-invoices. |
{
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"minimum": 1,
"description": "Invoice ID returned by search-invoices."
}
}
}Returns one authorized job using bounded customer, schedule, status, and technician fields; service addresses, notes, and amounts are excluded.
| Argument | Type | Description |
|---|---|---|
| job_id | integer | Job ID returned by search-jobs or jobs-today. |
{
"type": "object",
"properties": {
"job_id": {
"type": "integer",
"minimum": 1,
"description": "Job ID returned by search-jobs or jobs-today."
}
}
}Returns one authorized lead using bounded contact, source, status, and service-interest fields; notes, budget, and internal summaries are excluded.
| Argument | Type | Description |
|---|---|---|
| lead_id | integer | Lead ID returned by search-leads. |
{
"type": "object",
"properties": {
"lead_id": {
"type": "integer",
"minimum": 1,
"description": "Lead ID returned by search-leads."
}
}
}Returns one location and its public Google listing status. A confirmed place is not a Google Business Profile connection.
| Argument | Type | Description |
|---|---|---|
| location_id | integer | Location ID. |
{
"type": "object",
"properties": {
"location_id": {
"type": "integer",
"minimum": 1,
"description": "Location ID."
}
}
}Returns one authorized estimate with bounded customer, status, pricing, revision, and line-item fields; addresses, notes, and terms are excluded.
| Argument | Type | Description |
|---|---|---|
| quote_id | integer | Estimate ID returned by search-quotes. |
{
"type": "object",
"properties": {
"quote_id": {
"type": "integer",
"minimum": 1,
"description": "Estimate ID returned by search-quotes."
}
}
}Shows verified referral campaign totals and conversion activity without returning referral tokens or bearer-like links.
| Argument | Type | Description |
|---|---|---|
| days | integer | null | Lookback window in days. |
| campaign_id | integer | Referral campaign ID returned by search-referral-campaigns. |
{
"type": "object",
"properties": {
"days": {
"type": [
"integer",
"null"
],
"default": 30,
"maximum": 180,
"minimum": 1,
"description": "Lookback window in days."
},
"campaign_id": {
"type": "integer",
"minimum": 1,
"description": "Referral campaign ID returned by search-referral-campaigns."
}
}
}Returns one authorized service-request inbox record using bounded status, source, urgency, and scheduling fields without exposing request descriptions, addresses, contact channels, metadata, files, or outreach controls.
| Argument | Type | Description |
|---|---|---|
| service_request_id | integer | Service-request ID returned by search-service-requests. |
{
"type": "object",
"properties": {
"service_request_id": {
"type": "integer",
"minimum": 1,
"description": "Service-request ID returned by search-service-requests."
}
}
}Returns a limited, read-only summary of the authenticated FieldRobin workspace.
No arguments.
{
"type": "object",
"properties": {}
}Lists authorized jobs scheduled for a business day, with bounded customer, schedule, status, and technician fields.
| Argument | Type | Description |
|---|---|---|
| date | string | null | Local business date, YYYY-MM-DD; defaults to today. |
| limit | integer | null | Maximum number of jobs to return. |
| status | string | null | Optional job status filter. |
| technician_id | integer | null | Optional technician ID. |
{
"type": "object",
"properties": {
"date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Local business date, YYYY-MM-DD; defaults to today."
},
"limit": {
"type": [
"integer",
"null"
],
"default": 25,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of jobs to return."
},
"status": {
"type": [
"string",
"null"
],
"maxLength": 40,
"description": "Optional job status filter."
},
"technician_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional technician ID."
}
}
}Lists authorized private photos attached to one job with protected download URLs, filenames, captions, and media types.
| Argument | Type | Description |
|---|---|---|
| job_id | integer | Job ID returned by search-jobs. |
{
"type": "object",
"properties": {
"job_id": {
"type": "integer",
"minimum": 1,
"description": "Job ID returned by search-jobs."
}
}
}Reads bounded parts stock, technician exposure, and transaction metadata for the authenticated workspace without exposing amounts, item pricing, or private notes.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum inventory, transactions, and technician balances to return. |
| technician_id | integer | null | Optional same-business technician ID. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum inventory, transactions, and technician balances to return."
},
"technician_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional same-business technician ID."
}
}
}Reads bounded technician performance and coaching signals for the authenticated workspace without exposing coaching notes or private contact fields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum jobs sampled per technician. |
| technician_id | integer | null | Optional same-business technician ID. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum jobs sampled per technician."
},
"technician_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional same-business technician ID."
}
}
}Lists persisted pipeline attention items for the authenticated business without changing, dismissing, or executing them.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of actions to return. |
| priority | string | null | Optional priority filter. |
| due_before | string | null | Only actions due on or before this local date. |
| action_type | string | null | Optional exact action type. |
| action_state | string | null | Pipeline state; defaults to open. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 10,
"maximum": 20,
"minimum": 1,
"description": "Maximum number of actions to return."
},
"priority": {
"enum": [
"urgent",
"high",
"normal",
"low"
],
"type": [
"string",
"null"
],
"description": "Optional priority filter."
},
"due_before": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Only actions due on or before this local date."
},
"action_type": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Optional exact action type."
},
"action_state": {
"enum": [
"open",
"in_progress",
"snoozed",
"blocked",
"dismissed",
"done"
],
"type": [
"string",
"null"
],
"description": "Pipeline state; defaults to open."
}
}
}Lists persisted pipeline recommendations for the authenticated business without generating, editing, approving, rejecting, or executing them.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum recommendations to return. |
| status | string | null | Recommendation state; defaults to pending. |
| action_type | string | null | Optional exact pipeline recommendation action type. |
| recommendation_id | integer | null | Optional exact recommendation ID. |
| include_draft_history | boolean | null | When true, recommendation_id is required and bounded draft edit history is returned. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum recommendations to return."
},
"status": {
"enum": [
"pending",
"approved",
"rejected",
"expired"
],
"type": [
"string",
"null"
],
"description": "Recommendation state; defaults to pending."
},
"action_type": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Optional exact pipeline recommendation action type."
},
"recommendation_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional exact recommendation ID."
},
"include_draft_history": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "When true, recommendation_id is required and bounded draft edit history is returned."
}
}
}Previews one approved broadcast audience, including suppression and policy skips, without sending or changing records.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum audience items to evaluate. |
| campaign_id | integer | Broadcast campaign ID returned by search-broadcast-campaigns. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 25,
"maximum": 50,
"minimum": 1,
"description": "Maximum audience items to evaluate."
},
"campaign_id": {
"type": "integer",
"minimum": 1,
"description": "Broadcast campaign ID returned by search-broadcast-campaigns."
}
}
}Calculates a deterministic invoice preview without saving, charging, sending, or creating an invoice.
| Argument | Type | Description |
|---|---|---|
| items | array | Invoice line items. |
| tax_mode | string | null | |
| coupon_code | string | null | |
| customer_id | integer | Resolved customer ID; required for an invoice preview. |
| tax_rate_id | integer | null | |
| document_discount_type | string | null | |
| document_discount_value | number | null |
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"minimum": 0
},
"item_type": {
"enum": [
"material",
"labour",
"service",
"equipment",
"fee"
],
"type": [
"string",
"null"
]
},
"unit_price": {
"type": "number",
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 500
},
"tax_behavior": {
"enum": [
"inherit",
"taxable",
"non_taxable",
"automatic"
],
"type": [
"string",
"null"
]
},
"discount_type": {
"enum": [
"none",
"percentage",
"fixed"
],
"type": [
"string",
"null"
]
},
"discount_value": {
"type": [
"number",
"null"
],
"minimum": 0
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "Invoice line items."
},
"tax_mode": {
"enum": [
"none",
"manual"
],
"type": [
"string",
"null"
]
},
"coupon_code": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"customer_id": {
"type": "integer",
"minimum": 1,
"description": "Resolved customer ID; required for an invoice preview."
},
"tax_rate_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"document_discount_type": {
"enum": [
"none",
"percentage",
"fixed"
],
"type": [
"string",
"null"
]
},
"document_discount_value": {
"type": [
"number",
"null"
],
"minimum": 0
}
}
}Calculates a deterministic estimate preview without saving, sending, or creating a quote.
| Argument | Type | Description |
|---|---|---|
| items | array | Estimate line item. |
| tax_mode | string | null | |
| coupon_code | string | null | |
| customer_id | integer | null | Optional resolved customer ID. |
| tax_rate_id | integer | null | |
| document_discount_type | string | null | |
| document_discount_value | number | null |
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"minimum": 0
},
"item_type": {
"enum": [
"material",
"labour",
"service",
"equipment",
"fee"
],
"type": [
"string",
"null"
]
},
"unit_price": {
"type": "number",
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 500
},
"tax_behavior": {
"enum": [
"inherit",
"taxable",
"non_taxable",
"automatic"
],
"type": [
"string",
"null"
]
},
"discount_type": {
"enum": [
"none",
"percentage",
"fixed"
],
"type": [
"string",
"null"
]
},
"discount_value": {
"type": [
"number",
"null"
],
"minimum": 0
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "Estimate line item."
},
"tax_mode": {
"enum": [
"none",
"manual"
],
"type": [
"string",
"null"
]
},
"coupon_code": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"customer_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional resolved customer ID."
},
"tax_rate_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"document_discount_type": {
"enum": [
"none",
"percentage",
"fixed"
],
"type": [
"string",
"null"
]
},
"document_discount_value": {
"type": [
"number",
"null"
],
"minimum": 0
}
}
}Previews dormant customers eligible for one authorized reactivation campaign without sending or changing records.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum audience items to evaluate. |
| campaign_id | integer | Reactivation campaign ID returned by search-reactivation-campaigns. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 25,
"maximum": 50,
"minimum": 1,
"description": "Maximum audience items to evaluate."
},
"campaign_id": {
"type": "integer",
"minimum": 1,
"description": "Reactivation campaign ID returned by search-reactivation-campaigns."
}
}
}Previews eligible completed jobs for one authorized referral campaign without sending or changing records.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum audience items to evaluate. |
| campaign_id | integer | Referral campaign ID returned by search-referral-campaigns. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 25,
"maximum": 50,
"minimum": 1,
"description": "Maximum audience items to evaluate."
},
"campaign_id": {
"type": "integer",
"minimum": 1,
"description": "Referral campaign ID returned by search-referral-campaigns."
}
}
}Previews explicit completed jobs for review requests, including eligibility and skip reasons, without sending anything.
| Argument | Type | Description |
|---|---|---|
| channel | string | null | Optional review-request channel preference. |
| job_ids | array | Explicit job IDs to evaluate. |
{
"type": "object",
"properties": {
"channel": {
"enum": [
"sms",
"email"
],
"type": [
"string",
"null"
],
"description": "Optional review-request channel preference."
},
"job_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 50,
"minItems": 1,
"description": "Explicit job IDs to evaluate."
}
}
}Validates social post copy for an authorized source review without saving or publishing it.
| Argument | Type | Description |
|---|---|---|
| content | string | Proposed social post content. |
| platform | string | null | Social platform. |
| review_id | integer | null | Optional authorized source review ID. |
{
"type": "object",
"properties": {
"content": {
"type": "string",
"maxLength": 1200,
"minLength": 3,
"description": "Proposed social post content."
},
"platform": {
"enum": [
"facebook",
"instagram",
"google_business"
],
"type": [
"string",
"null"
],
"description": "Social platform."
},
"review_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional authorized source review ID."
}
}
}Compares revenue, activation, retention, and review-request outcomes by physical location. Does not expose customer names, invoice rows, or mutation access. Location writes stay on the in-product assistant, not MCP.
| Argument | Type | Description |
|---|---|---|
| period | integer | null | Number of days for location comparison metrics; defaults to 30. |
{
"type": "object",
"properties": {
"period": {
"enum": [
7,
30,
90,
365
],
"type": [
"integer",
"null"
],
"default": 30,
"description": "Number of days for location comparison metrics; defaults to 30."
}
}
}Ranks named customers by paid invoice revenue for the authenticated workspace. Uses all paid, non-sample invoices and returns aggregate customer totals without invoice rows.
| Argument | Type | Description |
|---|---|---|
| to | string | null | Inclusive end date when period is custom. |
| from | string | null | Inclusive start date when period is custom. |
| limit | integer | null | Maximum number of ranked customers to return. |
| period | string | null | Ranking window. Use all_time for to-date questions. |
{
"type": "object",
"properties": {
"to": {
"type": [
"string",
"null"
],
"description": "Inclusive end date when period is custom."
},
"from": {
"type": [
"string",
"null"
],
"description": "Inclusive start date when period is custom."
},
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 100,
"minimum": 1,
"description": "Maximum number of ranked customers to return."
},
"period": {
"enum": [
"all_time",
"7",
"30",
"90",
"365",
"custom"
],
"type": [
"string",
"null"
],
"default": "all_time",
"description": "Ranking window. Use all_time for to-date questions."
}
}
}Reads aggregate revenue, receivables, job, lead, and estimate performance for the authenticated workspace without exposing customer names, addresses, invoice rows, or mutation access.
| Argument | Type | Description |
|---|---|---|
| period | integer | null | Number of days for the bounded trend metrics; defaults to 30. |
{
"type": "object",
"properties": {
"period": {
"enum": [
7,
30,
90,
365
],
"type": [
"integer",
"null"
],
"default": 30,
"description": "Number of days for the bounded trend metrics; defaults to 30."
}
}
}Reads a local business day route and high driving-risk stops for the authenticated workspace without exposing addresses or private route notes.
| Argument | Type | Description |
|---|---|---|
| date | string | null | Local business date, YYYY-MM-DD; defaults to today. |
| limit | integer | null | Maximum route stops to return. |
| technician_id | integer | null | Optional technician filter. |
{
"type": "object",
"properties": {
"date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Local business date, YYYY-MM-DD; defaults to today."
},
"limit": {
"type": [
"integer",
"null"
],
"default": 50,
"maximum": 50,
"minimum": 1,
"description": "Maximum route stops to return."
},
"technician_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional technician filter."
}
}
}Calculates verified busy jobs and open planning windows for a local business day without scheduling or changing a job.
| Argument | Type | Description |
|---|---|---|
| date | string | null | Local business date, YYYY-MM-DD; defaults to today. |
| workday_end | integer | null | Planning window end hour. |
| technician_id | integer | null | Optional same-business technician ID. |
| workday_start | integer | null | Planning window start hour. |
| duration_minutes | integer | null | Requested appointment length. |
| job_duration_minutes | integer | null | Planning duration for existing jobs. |
{
"type": "object",
"properties": {
"date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Local business date, YYYY-MM-DD; defaults to today."
},
"workday_end": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 24,
"minimum": 1,
"description": "Planning window end hour."
},
"technician_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional same-business technician ID."
},
"workday_start": {
"type": [
"integer",
"null"
],
"default": 10,
"maximum": 23,
"minimum": 0,
"description": "Planning window start hour."
},
"duration_minutes": {
"type": [
"integer",
"null"
],
"default": 60,
"maximum": 480,
"minimum": 15,
"description": "Requested appointment length."
},
"job_duration_minutes": {
"type": [
"integer",
"null"
],
"default": 60,
"maximum": 480,
"minimum": 15,
"description": "Planning duration for existing jobs."
}
}
}Searches authorized broadcast campaigns by name, status, message channel, and bounded delivery fields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of campaigns to return. |
| query | string | null | Campaign name, message, or channel. |
| status | string | null | Campaign status. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of campaigns to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Campaign name, message, or channel."
},
"status": {
"enum": [
"draft",
"pending_approval",
"approved",
"rejected",
"sent",
"archived"
],
"type": [
"string",
"null"
],
"description": "Campaign status."
}
}
}Searches the authenticated workspace customers without exposing addresses, notes, or other private fields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of customers to return. |
| query | string | null | Name, email, phone, or business name to search for. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of customers to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Name, email, phone, or business name to search for."
}
}
}Searches active inventory in the authenticated workspace and can identify low-stock items without exposing internal cost or margin fields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum items to return. |
| query | string | null | Inventory name, SKU, or description. |
| active | boolean | null | Filter by active state; defaults to true. |
| low_stock | boolean | null | Only items at or below minimum quantity. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Inventory name, SKU, or description."
},
"active": {
"type": [
"boolean",
"null"
],
"description": "Filter by active state; defaults to true."
},
"low_stock": {
"type": [
"boolean",
"null"
],
"description": "Only items at or below minimum quantity."
}
}
}Searches authorized invoices using bounded customer, job, status, payment, due-date, and total fields; payment links and addresses are excluded.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of invoices to return. |
| query | string | null | Invoice number, customer name, email, phone, job title, or description. |
| job_id | integer | null | Restrict results to one job ID. |
| status | string | null | Invoice lifecycle status. |
| customer_id | integer | null | Restrict results to one customer ID. |
| payment_status | string | null | Authoritative payment state, such as unpaid, pending, paid, or refunded. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 10,
"maximum": 20,
"minimum": 1,
"description": "Maximum number of invoices to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Invoice number, customer name, email, phone, job title, or description."
},
"job_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Restrict results to one job ID."
},
"status": {
"enum": [
"draft",
"sent",
"overdue",
"paid",
"cancelled"
],
"type": [
"string",
"null"
],
"description": "Invoice lifecycle status."
},
"customer_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Restrict results to one customer ID."
},
"payment_status": {
"type": [
"string",
"null"
],
"maxLength": 40,
"description": "Authoritative payment state, such as unpaid, pending, paid, or refunded."
}
}
}Searches the authenticated workspace jobs using safe summary fields only; it does not return service addresses, notes, or amounts.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of jobs to return. |
| query | string | null | Customer name, email, phone, or job title. |
| status | string | null | Optional job status filter. |
| customer_id | integer | null | Restrict results to one customer ID. |
| location_id | integer | null | Restrict results to one business location ID. |
| scheduled_to | string | null | Inclusive scheduled date, YYYY-MM-DD. |
| scheduled_from | string | null | Inclusive scheduled date, YYYY-MM-DD. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of jobs to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Customer name, email, phone, or job title."
},
"status": {
"type": [
"string",
"null"
],
"maxLength": 40,
"description": "Optional job status filter."
},
"customer_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Restrict results to one customer ID."
},
"location_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Restrict results to one business location ID."
},
"scheduled_to": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Inclusive scheduled date, YYYY-MM-DD."
},
"scheduled_from": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Inclusive scheduled date, YYYY-MM-DD."
}
}
}Searches authorized workspace leads with bounded contact, source, status, and service-interest fields; notes and estimated values are excluded.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of leads to return. |
| query | string | null | Name, email, phone, source, or service interest. |
| source | string | null | Optional exact lead source. |
| status | string | null | Optional lead status. |
| urgency | string | null | Optional urgency: low, medium, or high. |
| customer_id | integer | null | Restrict results to a customer ID. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 10,
"maximum": 20,
"minimum": 1,
"description": "Maximum number of leads to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Name, email, phone, source, or service interest."
},
"source": {
"type": [
"string",
"null"
],
"maxLength": 100,
"description": "Optional exact lead source."
},
"status": {
"type": [
"string",
"null"
],
"maxLength": 40,
"description": "Optional lead status."
},
"urgency": {
"type": [
"string",
"null"
],
"maxLength": 20,
"description": "Optional urgency: low, medium, or high."
},
"customer_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Restrict results to a customer ID."
}
}
}Lists physical locations in the authenticated workspace.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | |
| query | string | null | Location name to search for. |
| status | string | null | active, archived, or all. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Location name to search for."
},
"status": {
"type": [
"string",
"null"
],
"description": "active, archived, or all."
}
}
}Searches active customer-facing services and materials in the authenticated workspace without exposing internal cost or markup fields.
| Argument | Type | Description |
|---|---|---|
| type | string | null | Service or material. |
| limit | integer | null | Maximum items to return. |
| query | string | null | Pricebook item name or description. |
| active | boolean | null | Filter by active state; defaults to true. |
{
"type": "object",
"properties": {
"type": {
"enum": [
"service",
"material"
],
"type": [
"string",
"null"
],
"description": "Service or material."
},
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Pricebook item name or description."
},
"active": {
"type": [
"boolean",
"null"
],
"description": "Filter by active state; defaults to true."
}
}
}Searches authorized estimates using bounded customer, status, title, and total fields; notes, terms, and addresses are excluded.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of estimates to return. |
| query | string | null | Estimate title, customer name, email, or phone. |
| status | string | null | Optional estimate status. |
| customer_id | integer | null | Restrict results to one customer ID. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 10,
"maximum": 20,
"minimum": 1,
"description": "Maximum number of estimates to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 80,
"description": "Estimate title, customer name, email, or phone."
},
"status": {
"enum": [
"draft",
"sent",
"changes_requested",
"approved",
"rejected",
"expired",
"converted"
],
"type": [
"string",
"null"
],
"description": "Optional estimate status."
},
"customer_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Restrict results to one customer ID."
}
}
}Searches authorized reactivation campaigns by name, status, channel, and job-type filter.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of campaigns to return. |
| query | string | null | Campaign name, message, channel, or job type. |
| status | string | null | Campaign status. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of campaigns to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Campaign name, message, channel, or job type."
},
"status": {
"enum": [
"active",
"paused",
"archived"
],
"type": [
"string",
"null"
],
"description": "Campaign status."
}
}
}Searches authorized referral campaigns by name, status, message channel, and bounded performance fields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of campaigns to return. |
| query | string | null | Campaign name, message, or channel. |
| status | string | null | Campaign status. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of campaigns to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Campaign name, message, or channel."
},
"status": {
"enum": [
"active",
"paused",
"archived"
],
"type": [
"string",
"null"
],
"description": "Campaign status."
}
}
}Searches authorized reviews by reviewer, customer, job, rating, platform, or reply status using bounded fields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of reviews to return. |
| query | string | null | Reviewer, customer, job title, review body, or platform. |
| platform | string | null | Review platform. |
| has_reply | boolean | null | Filter by whether an owner reply exists. |
| rating_max | integer | null | Maximum rating. |
| rating_min | integer | null | Minimum rating. |
| reply_status | string | null | Reply delivery state. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of reviews to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Reviewer, customer, job title, review body, or platform."
},
"platform": {
"enum": [
"google",
"facebook",
"yelp",
"industry",
"bbb",
"angi",
"thumbtack",
"custom"
],
"type": [
"string",
"null"
],
"description": "Review platform."
},
"has_reply": {
"type": [
"boolean",
"null"
],
"description": "Filter by whether an owner reply exists."
},
"rating_max": {
"type": [
"integer",
"null"
],
"maximum": 5,
"minimum": 1,
"description": "Maximum rating."
},
"rating_min": {
"type": [
"integer",
"null"
],
"maximum": 5,
"minimum": 1,
"description": "Minimum rating."
},
"reply_status": {
"enum": [
"none",
"pending",
"sent",
"failed"
],
"type": [
"string",
"null"
],
"description": "Reply delivery state."
}
}
}Finds bounded active service-request inbox records for the authenticated business without exposing request descriptions, addresses, contact channels, or outreach controls.
| Argument | Type | Description |
|---|---|---|
| q | string | null | Client name, service type, or request text. |
| view | string | null | Inbox view; defaults to active inbox records. |
| limit | integer | null | Maximum number of requests to return. |
| status | string | null | Optional exact active request status. |
| urgency | string | null | Optional urgency filter. |
{
"type": "object",
"properties": {
"q": {
"type": [
"string",
"null"
],
"maxLength": 255,
"description": "Client name, service type, or request text."
},
"view": {
"enum": [
"inbox",
"pending",
"converted",
"outreach",
"all"
],
"type": [
"string",
"null"
],
"description": "Inbox view; defaults to active inbox records."
},
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of requests to return."
},
"status": {
"enum": [
"sent",
"opened",
"submitted",
"reviewing",
"scheduled",
"quoted",
"converted"
],
"type": [
"string",
"null"
],
"description": "Optional exact active request status."
},
"urgency": {
"enum": [
"low",
"medium",
"high"
],
"type": [
"string",
"null"
],
"description": "Optional urgency filter."
}
}
}Searches authorized social drafts and returns bounded content, status, platform, source-review, and approval metadata.
| Argument | Type | Description |
|---|---|---|
| limit | integer | null | Maximum number of drafts to return. |
| query | string | null | Draft content, platform, status, or ID. |
| status | string | null | Draft approval state. |
| platform | string | null | Social platform. |
| review_id | integer | null | Optional source review ID. |
{
"type": "object",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of drafts to return."
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 120,
"description": "Draft content, platform, status, or ID."
},
"status": {
"enum": [
"pending_approval",
"approved",
"rejected",
"published"
],
"type": [
"string",
"null"
],
"description": "Draft approval state."
},
"platform": {
"enum": [
"facebook",
"instagram",
"google_business"
],
"type": [
"string",
"null"
],
"description": "Social platform."
},
"review_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Optional source review ID."
}
}
}| service_address | string | null | Service address, if known. |
| appointment_count | integer | null | Optional appointment count. |
| technician_user_id | integer | null | Verified technician user ID, if assigned. |
{
"type": "object",
"required": [
"title",
"idempotency_key"
],
"properties": {
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Short job title."
},
"status": {
"enum": [
"lead",
"pending",
"quoted",
"approved",
"scheduled"
],
"type": [
"string",
"null"
],
"description": "Initial job status."
},
"customer_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Verified customer ID, if the job belongs to an existing customer."
},
"description": {
"type": [
"string",
"null"
],
"description": "Readable issue and service description."
},
"location_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Business location for the job."
},
"voice_notes": {
"type": [
"string",
"null"
],
"description": "Optional internal voice-note text."
},
"scheduled_at": {
"type": [
"string",
"null"
],
"description": "Optional local wall-clock appointment date/time or ISO timestamp with offset."
},
"total_amount": {
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Optional quoted amount."
},
"idempotency_key": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Opaque retry key. Reuse it only for the same request to receive the verified result without creating a duplicate."
},
"service_address": {
"type": [
"string",
"null"
],
"maxLength": 2000,
"description": "Service address, if known."
},
"appointment_count": {
"type": [
"integer",
"null"
],
"maximum": 99,
"minimum": 1,
"description": "Optional appointment count."
},
"technician_user_id": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "Verified technician user ID, if assigned."
}
}
}