FieldPulse API Overview

What the FieldPulse developer API does, the data and endpoints it exposes, its rate limits, and how to get an API key and the Postman documentation.

Who uses this: Developers building custom integrations; you request an API key from FieldPulse Support. Availability: All regions; API key issued by FieldPulse.

The FieldPulse API is a developer interface that lets your other business apps read and write FieldPulse data and trigger actions across tools. Use it to push FieldPulse data into another application, or to have an action in one application create or update records in FieldPulse. The full reference lives in the FieldPulse API documentation on Postman, and you request an API key from FieldPulse Support to get started.

Overview

The FieldPulse API is an Application Programming Interface — a way for different software applications to communicate and share information with each other. It’s useful when you want to display FieldPulse data inside another app, or have an action in one application trigger a response in another.

Some of what teams build with it:

• CRMs — Create and update FieldPulse customers in a third-party CRM.

• Task tracking — Create and update subtasks on job records from a third-party task manager.

• Internal communication — Sync comments on jobs and customer records from tools like Slack or Microsoft Teams.

• Lead capture — Send lead data (name, email, address) captured on your website into FieldPulse.

• Lead management — Manage customer pipeline statuses from marketing and sales apps.

• Scheduling — Create and assign jobs to field technicians from a third-party app.

• Estimates & invoices — Send estimates and invoices, get their dynamic links, update preview settings, and sync invoices with accounting software. Includes marking estimates as converted once accepted.

• Material lists, custom fields, and contracts — Create material lists, push custom-field data in, and write and send contracts from a third-party tool into FieldPulse.

How it works

The API exposes FieldPulse records as endpoints you call over HTTP. Most endpoints support create, update, delete, and retrieve; a few are read-only.

Endpoint	Actions
Assets & Asset Categories	Create, update, delete, retrieve
Contracts	Retrieve
Customers	Create, update, delete, retrieve
Custom Fields	Create, update, delete, retrieve
Estimates	Create, update, delete, retrieve
Invoices	Create, update, delete, retrieve
Invoice Items	Create, retrieve
Jobs	Create, update, delete, retrieve
Lead Source	Retrieve
Locations	Create, update, delete, retrieve
Material Lists	Create, update, delete, retrieve
Payments	Create, update, delete, retrieve
Pipeline Status	Retrieve
Projects	Create, update, delete, retrieve
Purchase Orders	Create, update, delete, retrieve
Subtasks	Create, update, delete, retrieve
Tags	Create, update, delete, retrieve
Teams	Retrieve
Timesheets	Create, update, delete, retrieve
Comments	Create, update, delete, retrieve
Users	Retrieve
Vendors	Retrieve

Rate limit: The API enforces 50 requests per second. If you exceed it, requests return a 429 (Too Many Requests) response with a RateLimit-Reset header telling you when the limit resets.

Webhooks: FieldPulse currently offers webhooks for job statuses only. FieldPulse notifies all API users before any breaking changes.

Where to get access

1. Review the FieldPulse API documentation on Postman to find the endpoints for the data you want to view, create, or edit.

2. Contact FieldPulse Support at [e-mail] or through the in-app chat to request an API key and start the integration process.

Before you build, it’s worth mapping out what you want to automate, which apps you want FieldPulse data to reach (and whether those apps offer their own API), and exactly which FieldPulse data you need to create, edit, update, or view.

Related articles

• Zapier Overview

• How to Use Zapier With FieldPulse

If you’d rather connect apps without writing code, start with the Zapier Overview instead.