FieldPulse MCP by usefulapi is an MCP server published by io.usefulapi, hosted at fieldpulse.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 43 tools, including fieldpulse_list_customers, fieldpulse_get_customer, fieldpulse_list_customer_contacts, fieldpulse_get_customer_contact, fieldpulse_list_jobs.
Read FieldPulse customers, jobs, estimates, invoices, assets and projects; create and update jobs.
4,270 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List or search customers (name, email, phone, address, status, assigned user). GET /customers.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
| sort_by | string | one of ["searchable","email","phone","address_1"] |
| sort_dir | string | Sort direction. |
{
"name": "fieldpulse_list_customers",
"title": "List customers",
"description": "List or search customers (name, email, phone, address, status, assigned user). GET /customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
},
"sort_by": {
"enum": [
"searchable",
"email",
"phone",
"address_1"
],
"type": "string"
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "List customers",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One customer by id. GET /customers/{id}.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | integer | FieldPulse customer id. |
{
"name": "fieldpulse_get_customer",
"title": "Get customer",
"description": "One customer by id. GET /customers/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse customer id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get customer",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The contacts (people) of one customer. GET /customers/{customerId}/customer-contact.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| customer_id * | integer | FieldPulse customer id. |
{
"name": "fieldpulse_list_customer_contacts",
"title": "List customer contacts",
"description": "The contacts (people) of one customer. GET /customers/{customerId}/customer-contact.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse customer id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List customer contacts",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One contact of a customer. GET /customers/{customerId}/customer-contact/{contactId}.
| Parameter | Type | Description |
|---|---|---|
| contact_id * | integer | Customer contact id. |
| customer_id * | integer | FieldPulse customer id. |
{
"name": "fieldpulse_get_customer_contact",
"title": "Get customer contact",
"description": "One contact of a customer. GET /customers/{customerId}/customer-contact/{contactId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"contact_id"
],
"properties": {
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Customer contact id.",
"exclusiveMinimum": 0
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse customer id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get customer contact",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List or search jobs (type, status, customer, schedule, assignments), optionally within a created-at range or by custom status ids. GET /jobs.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
| sort_by | string | one of ["created_at","updated_at"] |
| sort_dir | string | Sort direction. |
| created_to | string | Only jobs created at or before this time. |
| status_ids | array | Only jobs in these custom status ids (see fieldpulse_list_job_workflow_statuses). |
| created_from | string | Only jobs created at or after this time (yyyy-mm-dd or ISO 8601 with a timezone). |
| with_custom_fields | boolean | Include each job's custom field values (customfields_with_related_data). |
One job by id, optionally with its custom field values. GET /jobs/{id}.
| Parameter | Type | Description |
|---|---|---|
| job_id * | integer | FieldPulse job id. |
| with_custom_fields | boolean | Include custom field values. |
{
"name": "fieldpulse_get_job",
"title": "Get job",
"description": "One job by id, optionally with its custom field values. GET /jobs/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse job id.",
"exclusiveMinimum": 0
},
"with_custom_fields": {
"type": "boolean",
"description": "Include custom field values."
}
}
},
"annotations": {
"title": "Get job",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The job status workflows (use their ids with fieldpulse_list_job_workflow_statuses and when setting a custom job status). GET /jobs/status-workflows.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_job_status_workflows",
"title": "List job status workflows",
"description": "The job status workflows (use their ids with fieldpulse_list_job_workflow_statuses and when setting a custom job status). GET /jobs/status-workflows.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List job status workflows",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The custom job statuses of all workflows, with their ids (for filtering jobs or setting a status). GET /jobs/status-workflow-statuses.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_job_workflow_statuses",
"title": "List job workflow statuses",
"description": "The custom job statuses of all workflows, with their ids (for filtering jobs or setting a status). GET /jobs/status-workflow-statuses.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List job workflow statuses",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List or search estimates (customer, status, totals, line items). GET /estimates.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
| sort_by | string | An attribute of the record, e.g. created_at. |
| sort_dir | string | Sort direction. |
{
"name": "fieldpulse_list_estimates",
"title": "List estimates",
"description": "List or search estimates (customer, status, totals, line items). GET /estimates.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
},
"sort_by": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,49}$",
"description": "An attribute of the record, e.g. created_at."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "List estimates",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One estimate by id. GET /estimates/{id}.
| Parameter | Type | Description |
|---|---|---|
| estimate_id * | integer | FieldPulse estimate id. |
{
"name": "fieldpulse_get_estimate",
"title": "Get estimate",
"description": "One estimate by id. GET /estimates/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"estimate_id"
],
"properties": {
"estimate_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse estimate id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get estimate",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List or search invoices (customer, status, totals, due dates). GET /invoices.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
| sort_by | string | An attribute of the record, e.g. created_at. |
| sort_dir | string | Sort direction. |
{
"name": "fieldpulse_list_invoices",
"title": "List invoices",
"description": "List or search invoices (customer, status, totals, due dates). GET /invoices.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
},
"sort_by": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,49}$",
"description": "An attribute of the record, e.g. created_at."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "List invoices",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One invoice by id. GET /invoices/{id}.
| Parameter | Type | Description |
|---|---|---|
| invoice_id * | integer | FieldPulse invoice id. |
{
"name": "fieldpulse_get_invoice",
"title": "Get invoice",
"description": "One invoice by id. GET /invoices/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"invoice_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse invoice id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get invoice",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List or search payments (amount, method, date, invoice). GET /payments.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
| sort_by | string | one of ["cuid","method","amount","payment_date"] |
| sort_dir | string | Sort direction. |
{
"name": "fieldpulse_list_payments",
"title": "List payments",
"description": "List or search payments (amount, method, date, invoice). GET /payments.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
},
"sort_by": {
"enum": [
"cuid",
"method",
"amount",
"payment_date"
],
"type": "string"
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "List payments",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One payment by id. GET /payments/{id}.
| Parameter | Type | Description |
|---|---|---|
| payment_id * | integer | FieldPulse payment id. |
{
"name": "fieldpulse_get_payment",
"title": "Get payment",
"description": "One payment by id. GET /payments/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"payment_id"
],
"properties": {
"payment_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse payment id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get payment",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List or search customer assets (equipment) by install status. GET /assets.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
| status | string | one of ["uninstalled","installed","retired"] |
{
"name": "fieldpulse_list_assets",
"title": "List assets",
"description": "List or search customer assets (equipment) by install status. GET /assets.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
},
"status": {
"enum": [
"uninstalled",
"installed",
"retired"
],
"type": "string"
}
}
},
"annotations": {
"title": "List assets",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One asset by id. GET /assets/{id}.
| Parameter | Type | Description |
|---|---|---|
| asset_id * | integer | FieldPulse asset id. |
{
"name": "fieldpulse_get_asset",
"title": "Get asset",
"description": "One asset by id. GET /assets/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"asset_id"
],
"properties": {
"asset_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse asset id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get asset",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List asset categories. GET /assets-category.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
{
"name": "fieldpulse_list_asset_categories",
"title": "List asset categories",
"description": "List asset categories. GET /assets-category.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
}
}
},
"annotations": {
"title": "List asset categories",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List locations (service addresses) of a customer or a job. GET /locations.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| object_id | integer | Id of the customer or job (needs object_type). |
| object_type | string | one of ["customer","job"] |
{
"name": "fieldpulse_list_locations",
"title": "List locations",
"description": "List locations (service addresses) of a customer or a job. GET /locations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"object_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the customer or job (needs object_type).",
"exclusiveMinimum": 0
},
"object_type": {
"enum": [
"customer",
"job"
],
"type": "string"
}
}
},
"annotations": {
"title": "List locations",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One location by id. GET /locations/{id}.
| Parameter | Type | Description |
|---|---|---|
| location_id * | integer | FieldPulse location id. |
{
"name": "fieldpulse_get_location",
"title": "Get location",
"description": "One location by id. GET /locations/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"location_id"
],
"properties": {
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse location id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get location",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List or search projects (status, completion). GET /projects.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
| sort_by | string | one of ["cuid","name","status_id","completion_percentage"] |
| sort_dir | string | Sort direction. |
{
"name": "fieldpulse_list_projects",
"title": "List projects",
"description": "List or search projects (status, completion). GET /projects.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
},
"sort_by": {
"enum": [
"cuid",
"name",
"status_id",
"completion_percentage"
],
"type": "string"
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "List projects",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One project by id. GET /projects/{id}.
| Parameter | Type | Description |
|---|---|---|
| project_id * | integer | FieldPulse project id. |
{
"name": "fieldpulse_get_project",
"title": "Get project",
"description": "One project by id. GET /projects/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"project_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse project id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get project",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List contracts (maintenance agreements). GET /contracts.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_contracts",
"title": "List contracts",
"description": "List contracts (maintenance agreements). GET /contracts.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List contracts",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One contract by id. GET /contracts/{id}.
| Parameter | Type | Description |
|---|---|---|
| contract_id * | integer | FieldPulse contract id. |
{
"name": "fieldpulse_get_contract",
"title": "Get contract",
"description": "One contract by id. GET /contracts/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contract_id"
],
"properties": {
"contract_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse contract id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get contract",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the invoice item catalog (products and services with prices). GET /items.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_items",
"title": "List items",
"description": "List the invoice item catalog (products and services with prices). GET /items.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List items",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One invoice item by id. GET /items/{id}.
| Parameter | Type | Description |
|---|---|---|
| item_id * | integer | FieldPulse item id. |
{
"name": "fieldpulse_get_item",
"title": "Get item",
"description": "One invoice item by id. GET /items/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"item_id"
],
"properties": {
"item_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse item id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get item",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List purchase orders. GET /purchase-orders.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_purchase_orders",
"title": "List purchase orders",
"description": "List purchase orders. GET /purchase-orders.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List purchase orders",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One purchase order by id. GET /purchase-orders/{id}.
| Parameter | Type | Description |
|---|---|---|
| purchase_order_id * | integer | FieldPulse purchase order id. |
{
"name": "fieldpulse_get_purchase_order",
"title": "Get purchase order",
"description": "One purchase order by id. GET /purchase-orders/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"purchase_order_id"
],
"properties": {
"purchase_order_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse purchase order id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get purchase order",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List vendors (suppliers). GET /vendors.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
{
"name": "fieldpulse_list_vendors",
"title": "List vendors",
"description": "List vendors (suppliers). GET /vendors.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
}
}
},
"annotations": {
"title": "List vendors",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One vendor by id. GET /vendors/{id}.
| Parameter | Type | Description |
|---|---|---|
| vendor_id * | integer | FieldPulse vendor id. |
{
"name": "fieldpulse_get_vendor",
"title": "Get vendor",
"description": "One vendor by id. GET /vendors/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vendor_id"
],
"properties": {
"vendor_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse vendor id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get vendor",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The company profile(s) of this FieldPulse account (name, address, contact details, settings). GET /company-profile.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| search | string | Free-text search string. |
{
"name": "fieldpulse_list_company_profiles",
"title": "List company profiles",
"description": "The company profile(s) of this FieldPulse account (name, address, contact details, settings). GET /company-profile.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
}
}
},
"annotations": {
"title": "List company profiles",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the account's users (team members) with ids for assignments. GET /users.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_users",
"title": "List users",
"description": "List the account's users (team members) with ids for assignments. GET /users.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List users",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the account's teams. GET /teams.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_teams",
"title": "List teams",
"description": "List the account's teams. GET /teams.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List teams",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List tags for customers or jobs. GET /tags.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| object_type | string | one of ["customer","job"] |
{
"name": "fieldpulse_list_tags",
"title": "List tags",
"description": "List tags for customers or jobs. GET /tags.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"object_type": {
"enum": [
"customer",
"job"
],
"type": "string"
}
}
},
"annotations": {
"title": "List tags",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List customer lead sources. GET /lead-source.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_lead_sources",
"title": "List lead sources",
"description": "List customer lead sources. GET /lead-source.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List lead sources",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List customer pipeline statuses. GET /pipeline-status.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
{
"name": "fieldpulse_list_pipeline_statuses",
"title": "List pipeline statuses",
"description": "List customer pipeline statuses. GET /pipeline-status.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List pipeline statuses",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List custom field definitions, optionally for one object type. GET /custom-fields.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| object_type | string | one of ["customer","job","invoice","item","maintenance_agreement","project","asset","material_list"] |
{
"name": "fieldpulse_list_custom_fields",
"title": "List custom fields",
"description": "List custom field definitions, optionally for one object type. GET /custom-fields.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"object_type": {
"enum": [
"customer",
"job",
"invoice",
"item",
"maintenance_agreement",
"project",
"asset",
"material_list"
],
"type": "string"
}
}
},
"annotations": {
"title": "List custom fields",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List comments on a record (customer, job, project, subtasks, invoice). GET /comments.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| object_id | integer | Id of the record (needs object_type). |
| object_type | string | one of ["customer","job","project","subtasks","invoice"] |
{
"name": "fieldpulse_list_comments",
"title": "List comments",
"description": "List comments on a record (customer, job, project, subtasks, invoice). GET /comments.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"object_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the record (needs object_type).",
"exclusiveMinimum": 0
},
"object_type": {
"enum": [
"customer",
"job",
"project",
"subtasks",
"invoice"
],
"type": "string"
}
}
},
"annotations": {
"title": "List comments",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List subtasks (job checklist items) by status or assigned user. GET /subtasks.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Records per page, 1-100 (default 25). |
| status | string | one of ["open","close"] |
| sort_by | string | one of ["due_date","status","title"] |
| sort_dir | string | Sort direction. |
| assigned_user_id | integer | Only subtasks assigned to this user id. |
{
"name": "fieldpulse_list_subtasks",
"title": "List subtasks",
"description": "List subtasks (job checklist items) by status or assigned user. GET /subtasks.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"status": {
"enum": [
"open",
"close"
],
"type": "string"
},
"sort_by": {
"enum": [
"due_date",
"status",
"title"
],
"type": "string"
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"assigned_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only subtasks assigned to this user id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List subtasks",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List timesheet entries (clock in/out), optionally for one user or a time window. GET /timesheets.
| Parameter | Type | Description |
|---|---|---|
| type | string | Entry type, e.g. job. |
| limit | integer | Records per page, 1-100 (default 25). |
| in_time | string | Clock-in time filter (yyyy-mm-dd or ISO 8601 with a timezone). |
| user_id | integer | Only this user's entries. |
| out_time | string | Clock-out time filter. |
{
"name": "fieldpulse_list_timesheets",
"title": "List timesheets",
"description": "List timesheet entries (clock in/out), optionally for one user or a time window. GET /timesheets.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Entry type, e.g. job."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"in_time": {
"type": "string",
"description": "Clock-in time filter (yyyy-mm-dd or ISO 8601 with a timezone)."
},
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this user's entries.",
"exclusiveMinimum": 0
},
"out_time": {
"type": "string",
"description": "Clock-out time filter."
}
}
},
"annotations": {
"title": "List timesheets",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a customer (lead or account). Give first_name and/or last_name, or a unique display_name. Creates a new record every call; check fieldpulse_list_customers first to avoid duplicates. POST /customers.
| Parameter | Type | Description |
|---|---|---|
| tags | array | Existing customer tag ids (see fieldpulse_list_tags). |
| string | ||
| notes | string | |
| phone | string | A valid phone number. |
| status | string | one of ["lead","opportunity","current customer","lost","other","inactive"] |
| alt_email | string | |
| job_notes | string | |
| last_name | string | |
| first_name | string | |
| assigned_to | any | User id the customer is assigned to (see fieldpulse_list_users); null clears it. |
| account_type | string | one of ["individual","company"] |
WRITE: change fields of one customer (only the fields you pass). If FieldPulse asks for a name, include first_name/last_name or display_name. PUT /customers/{customerId}.
| Parameter | Type | Description |
|---|---|---|
| tags | array | Existing customer tag ids (see fieldpulse_list_tags). |
| string | ||
| notes | string | |
| phone | string | A valid phone number. |
| status | string | one of ["lead","opportunity","current customer","lost","other","inactive"] |
| alt_email | string | |
| job_notes | string | |
| last_name | string | |
| first_name | string | |
| assigned_to | any | User id the customer is assigned to (see fieldpulse_list_users); null clears it. |
| customer_id * | integer |
WRITE: create a job for an existing customer. Needs customer_id, job_type and the numeric billing value FieldPulse requires; set a status (1-6) or a custom status_id + status_workflow_id. Creates a new job every call. POST /jobs.
| Parameter | Type | Description |
|---|---|---|
| tags | array | Existing job tag ids (see fieldpulse_list_tags). |
| notes | string | |
| status | integer | 1 = new, 2 = in progress, 3 = pending, 4 = completed, 5 = canceled, 6 = on the way. |
| billing * | integer | The integer billing value FieldPulse requires for a job. |
| due_date | ["string","null"] | Due date, yyyy-mm-dd or ISO 8601 with a timezone. |
| end_time | ["string","null"] | End, yyyy-mm-dd or ISO 8601 with a timezone. |
| job_type * | string | Job type label, e.g. the service name. |
| subtitle | string | |
| status_id | integer | A custom status id (see fieldpulse_list_job_workflow_statuses); needs status_workflow_id. |
| project_id |
WRITE: change a job: status, schedule, notes, assignments, location. FieldPulse requires customer_id, job_type and billing on every update, so this reads the job first and keeps those (and its current status) unless you pass new values. The read and the write are two requests; FieldPulse offers no version check. PUT /jobs/{jobId}.
| Parameter | Type | Description |
|---|---|---|
| tags | array | Existing job tag ids (see fieldpulse_list_tags). |
| notes | string | |
| job_id * | integer | FieldPulse job id. |
| status | integer | 1 = new, 2 = in progress, 3 = pending, 4 = completed, 5 = canceled, 6 = on the way. |
| billing | integer | |
| due_date | ["string","null"] | Due date, yyyy-mm-dd or ISO 8601 with a timezone. |
| end_time | ["string","null"] | End, yyyy-mm-dd or ISO 8601 with a timezone. |
| job_type | string | |
| subtitle | string | |
| status_id | integer |
Tools for FieldPulse, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "List the jobs created this week with their status and who is assigned to them."; "Show the details and the balance due of invoice 1234."; "Create a customer lead for Maria Lopez, phone 555-0142, with a service address on Oak Street.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes FieldPulse data. Free plan: 50 tool calls per month. Run fieldpulse_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run fieldpulse_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run fieldpulse_upgrade without a plan: it returns both plans, each with a payment link for the user to open. fieldpulse_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
{
"name": "fieldpulse_list_jobs",
"title": "List jobs",
"description": "List or search jobs (type, status, customer, schedule, assignments), optionally within a created-at range or by custom status ids. GET /jobs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Records per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search string."
},
"sort_by": {
"enum": [
"created_at",
"updated_at"
],
"type": "string"
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"created_to": {
"type": "string",
"description": "Only jobs created at or before this time."
},
"status_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Only jobs in these custom status ids (see fieldpulse_list_job_workflow_statuses)."
},
"created_from": {
"type": "string",
"description": "Only jobs created at or after this time (yyyy-mm-dd or ISO 8601 with a timezone)."
},
"with_custom_fields": {
"type": "boolean",
"description": "Include each job's custom field values (customfields_with_related_data)."
}
}
},
"annotations": {
"title": "List jobs",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}| billing_city | string |
| company_name | string |
| display_name | string | Required by FieldPulse when first and last name are empty; must be unique. |
| billing_state | string |
| lead_source_id | integer | See fieldpulse_list_lead_sources. |
| secondary_email | string |
| secondary_phone | string | A valid phone number. |
| billing_zip_code | string |
| billing_address_1 | string |
| billing_address_2 | string |
| service_address_1 | string |
| service_address_2 | string |
| pipeline_status_id | integer | See fieldpulse_list_pipeline_statuses. |
| service_address_city | string |
| service_address_state | string |
| service_address_zip_code | string |
| has_different_billing_address | boolean |
{
"name": "fieldpulse_create_customer",
"title": "Create customer",
"description": "WRITE: create a customer (lead or account). Give first_name and/or last_name, or a unique display_name. Creates a new record every call; check fieldpulse_list_customers first to avoid duplicates. POST /customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Existing customer tag ids (see fieldpulse_list_tags)."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 255
},
"notes": {
"type": "string",
"maxLength": 7500
},
"phone": {
"type": "string",
"maxLength": 255,
"description": "A valid phone number."
},
"status": {
"enum": [
"lead",
"opportunity",
"current customer",
"lost",
"other",
"inactive"
],
"type": "string"
},
"alt_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 255
},
"job_notes": {
"type": "string",
"maxLength": 4000
},
"last_name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"first_name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"assigned_to": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "User id the customer is assigned to (see fieldpulse_list_users); null clears it."
},
"account_type": {
"enum": [
"individual",
"company"
],
"type": "string"
},
"billing_city": {
"type": "string",
"maxLength": 255
},
"company_name": {
"type": "string",
"maxLength": 255
},
"display_name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Required by FieldPulse when first and last name are empty; must be unique."
},
"billing_state": {
"type": "string",
"maxLength": 255
},
"lead_source_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "See fieldpulse_list_lead_sources.",
"exclusiveMinimum": 0
},
"secondary_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 255
},
"secondary_phone": {
"type": "string",
"maxLength": 255,
"description": "A valid phone number."
},
"billing_zip_code": {
"type": "string",
"maxLength": 255
},
"billing_address_1": {
"type": "string",
"maxLength": 1000
},
"billing_address_2": {
"type": "string",
"maxLength": 1000
},
"service_address_1": {
"type": "string",
"maxLength": 255
},
"service_address_2": {
"type": "string",
"maxLength": 255
},
"pipeline_status_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "See fieldpulse_list_pipeline_statuses.",
"exclusiveMinimum": 0
},
"service_address_city": {
"type": "string",
"maxLength": 255
},
"service_address_state": {
"type": "string",
"maxLength": 255
},
"service_address_zip_code": {
"type": "string",
"maxLength": 255
},
"has_different_billing_address": {
"type": "boolean"
}
}
},
"annotations": {
"title": "Create customer",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}| FieldPulse customer id. |
| account_type | string | one of ["individual","company"] |
| billing_city | string |
| company_name | string |
| display_name | string | Required by FieldPulse when first and last name are empty; must be unique. |
| billing_state | string |
| lead_source_id | integer | See fieldpulse_list_lead_sources. |
| secondary_email | string |
| secondary_phone | string | A valid phone number. |
| billing_zip_code | string |
| billing_address_1 | string |
| billing_address_2 | string |
| service_address_1 | string |
| service_address_2 | string |
| pipeline_status_id | integer | See fieldpulse_list_pipeline_statuses. |
| service_address_city | string |
| service_address_state | string |
| service_address_zip_code | string |
| has_different_billing_address | boolean |
{
"name": "fieldpulse_update_customer",
"title": "Update customer",
"description": "WRITE: change fields of one customer (only the fields you pass). If FieldPulse asks for a name, include first_name/last_name or display_name. PUT /customers/{customerId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Existing customer tag ids (see fieldpulse_list_tags)."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 255
},
"notes": {
"type": "string",
"maxLength": 7500
},
"phone": {
"type": "string",
"maxLength": 255,
"description": "A valid phone number."
},
"status": {
"enum": [
"lead",
"opportunity",
"current customer",
"lost",
"other",
"inactive"
],
"type": "string"
},
"alt_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 255
},
"job_notes": {
"type": "string",
"maxLength": 4000
},
"last_name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"first_name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"assigned_to": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "User id the customer is assigned to (see fieldpulse_list_users); null clears it."
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse customer id.",
"exclusiveMinimum": 0
},
"account_type": {
"enum": [
"individual",
"company"
],
"type": "string"
},
"billing_city": {
"type": "string",
"maxLength": 255
},
"company_name": {
"type": "string",
"maxLength": 255
},
"display_name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Required by FieldPulse when first and last name are empty; must be unique."
},
"billing_state": {
"type": "string",
"maxLength": 255
},
"lead_source_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "See fieldpulse_list_lead_sources.",
"exclusiveMinimum": 0
},
"secondary_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 255
},
"secondary_phone": {
"type": "string",
"maxLength": 255,
"description": "A valid phone number."
},
"billing_zip_code": {
"type": "string",
"maxLength": 255
},
"billing_address_1": {
"type": "string",
"maxLength": 1000
},
"billing_address_2": {
"type": "string",
"maxLength": 1000
},
"service_address_1": {
"type": "string",
"maxLength": 255
},
"service_address_2": {
"type": "string",
"maxLength": 255
},
"pipeline_status_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "See fieldpulse_list_pipeline_statuses.",
"exclusiveMinimum": 0
},
"service_address_city": {
"type": "string",
"maxLength": 255
},
"service_address_state": {
"type": "string",
"maxLength": 255
},
"service_address_zip_code": {
"type": "string",
"maxLength": 255
},
"has_different_billing_address": {
"type": "boolean"
}
}
},
"annotations": {
"title": "Update customer",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}| any |
| start_time | ["string","null"] | Start, yyyy-mm-dd or ISO 8601 with a timezone. |
| assignments | array | Who the job is assigned to. |
| customer_id * | integer | Existing customer id. |
| field_notes | string |
| location_id | any | A location of the customer (see fieldpulse_list_locations). |
| status_workflow_id | integer | The status workflow of status_id (see fieldpulse_list_job_status_workflows). |
| customer_contact_id | any |
{
"name": "fieldpulse_create_job",
"title": "Create job",
"description": "WRITE: create a job for an existing customer. Needs customer_id, job_type and the numeric billing value FieldPulse requires; set a status (1-6) or a custom status_id + status_workflow_id. Creates a new job every call. POST /jobs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id",
"job_type",
"billing"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Existing job tag ids (see fieldpulse_list_tags)."
},
"notes": {
"type": "string",
"maxLength": 7500
},
"status": {
"type": "integer",
"maximum": 6,
"minimum": 1,
"description": "1 = new, 2 = in progress, 3 = pending, 4 = completed, 5 = canceled, 6 = on the way."
},
"billing": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The integer billing value FieldPulse requires for a job."
},
"due_date": {
"type": [
"string",
"null"
],
"description": "Due date, yyyy-mm-dd or ISO 8601 with a timezone."
},
"end_time": {
"type": [
"string",
"null"
],
"description": "End, yyyy-mm-dd or ISO 8601 with a timezone."
},
"job_type": {
"type": "string",
"maxLength": 150,
"minLength": 1,
"description": "Job type label, e.g. the service name."
},
"subtitle": {
"type": "string",
"maxLength": 150
},
"status_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "A custom status id (see fieldpulse_list_job_workflow_statuses); needs status_workflow_id.",
"exclusiveMinimum": 0
},
"project_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"start_time": {
"type": [
"string",
"null"
],
"description": "Start, yyyy-mm-dd or ISO 8601 with a timezone."
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"required": [
"assigned_members"
],
"properties": {
"team_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Team id (see fieldpulse_list_teams)."
},
"assigned_members": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "User ids (see fieldpulse_list_users)."
}
}
},
"maxItems": 50,
"description": "Who the job is assigned to."
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Existing customer id.",
"exclusiveMinimum": 0
},
"field_notes": {
"type": "string",
"maxLength": 5000
},
"location_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "A location of the customer (see fieldpulse_list_locations)."
},
"status_workflow_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The status workflow of status_id (see fieldpulse_list_job_status_workflows).",
"exclusiveMinimum": 0
},
"customer_contact_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
}
}
},
"annotations": {
"title": "Create job",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}| A custom status id (see fieldpulse_list_job_workflow_statuses); needs status_workflow_id. |
| project_id | any |
| start_time | ["string","null"] | Start, yyyy-mm-dd or ISO 8601 with a timezone. |
| assignments | array | Who the job is assigned to. |
| customer_id | integer |
| field_notes | string |
| location_id | any | A location of the customer (see fieldpulse_list_locations). |
| status_workflow_id | integer | The status workflow of status_id (see fieldpulse_list_job_status_workflows). |
| customer_contact_id | any |
{
"name": "fieldpulse_update_job",
"title": "Update job",
"description": "WRITE: change a job: status, schedule, notes, assignments, location. FieldPulse requires customer_id, job_type and billing on every update, so this reads the job first and keeps those (and its current status) unless you pass new values. The read and the write are two requests; FieldPulse offers no version check. PUT /jobs/{jobId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Existing job tag ids (see fieldpulse_list_tags)."
},
"notes": {
"type": "string",
"maxLength": 7500
},
"job_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "FieldPulse job id.",
"exclusiveMinimum": 0
},
"status": {
"type": "integer",
"maximum": 6,
"minimum": 1,
"description": "1 = new, 2 = in progress, 3 = pending, 4 = completed, 5 = canceled, 6 = on the way."
},
"billing": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"due_date": {
"type": [
"string",
"null"
],
"description": "Due date, yyyy-mm-dd or ISO 8601 with a timezone."
},
"end_time": {
"type": [
"string",
"null"
],
"description": "End, yyyy-mm-dd or ISO 8601 with a timezone."
},
"job_type": {
"type": "string",
"maxLength": 150,
"minLength": 1
},
"subtitle": {
"type": "string",
"maxLength": 150
},
"status_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "A custom status id (see fieldpulse_list_job_workflow_statuses); needs status_workflow_id.",
"exclusiveMinimum": 0
},
"project_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"start_time": {
"type": [
"string",
"null"
],
"description": "Start, yyyy-mm-dd or ISO 8601 with a timezone."
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"required": [
"assigned_members"
],
"properties": {
"team_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Team id (see fieldpulse_list_teams)."
},
"assigned_members": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "User ids (see fieldpulse_list_users)."
}
}
},
"maxItems": 50,
"description": "Who the job is assigned to."
},
"customer_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"field_notes": {
"type": "string",
"maxLength": 5000
},
"location_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "A location of the customer (see fieldpulse_list_locations)."
},
"status_workflow_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The status workflow of status_id (see fieldpulse_list_job_status_workflows).",
"exclusiveMinimum": 0
},
"customer_contact_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
}
}
},
"annotations": {
"title": "Update job",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}