Skip to main content
Open API
Updated over a week ago

APIs, or Application Programming Interfaces, allow different software applications to communicate and share information with each other. This is helpful for displaying one app’s data in another application, or having certain actions in one application trigger a response in another.

We recommend reviewing our documentation thoroughly to identify if our API can automate your tasks. Think about:

  • What you want to automate

  • What other applications you want FieldPulse data to be available in

    • Does this application also provide an open API?

  • What FieldPulse data you want to create, edit, update, or view.

(Note: The API is currently in Alpha, meaning that endpoints, request formats, and response formats remain subject to change. We will notify all API users if any breaking changes are going to be made. Additionally, we do not currently offer webhooks, but plan to add them in the future.)


What can you do with FieldPulse’s API?

Our API allows you to access all sorts of data. Some examples include:

  • CRMs: Create and update FieldPulse customers in a 3rd party Customer Relationship Management (CRM) tool.

  • Task Tracking: Create and update subtasks on job records from a 3rd party task management system.

  • Internal Communication: Sync comments on jobs and customer records from your team’s communication tool (Slack, Microsoft Teams, etc.).

  • Lead Capture: Send lead data such as customer name, email, address, etc. captured on your company’s website to FieldPulse.

  • Lead Management: Manage customer pipeline statuses in marketing and sales applications.

  • Scheduling: Create and assign jobs to field technicians using a 3rd party application.

  • Invoicing: Sync invoices with accounting software for seamless billing.

  • Estimates: Update estimates to converted within another platform.

  • Custom Fields: Use forms and custom fields in another tool to send customer data to FieldPulse.

  • Contracts: Write and send contracts from a 3rd party into FieldPulse.


How can I get started?

To begin using our API, explore our API documentation to discover which endpoints enable you to view, create, and edit data. You will also need to contact us at support@fieldpulse.com or use the chat feature in the bottom right corner of your screen to obtain an API key and start the integration process.


API Endpoint & Function Overview

Endpoint

Actions

Assets & Asset Categories

Create, update, delete, and retrieve

Contracts

Retrieve

Customers

Create, update, delete, and retrieve

Custom Fields

Create, update, delete, and retrieve

Estimates

Create, update, delete, and retrieve

Forms

Create, update, delete, and retrieve

Form Templates

Create, update, delete, and retrieve

Invoices

Create, update, delete, and retrieve

Invoice Items

Create, retrieve

Jobs

Create, update, delete, and retrieve

Lead Source

Retrieve

Locations

Create, update, delete, and retrieve

Payments

Create, update, delete, and retrieve

Pipeline Status

Retrieve

Projects

Create, update, delete, and retrieve

Purchase Orders

Create, update, delete, and retrieve

Subtasks

Create, update, delete, and retrieve

Tags

Create, update, delete, and retrieve

Teams

Retrieve

Timesheets

Create, update, delete, and retrieve

Comments

Create, update, delete, and retrieve

Users

Retrieve

Vendors

Retrieve


Have additional questions?

Contact us at support@fieldpulse.com or use the chat feature in the bottom right corner of your screen.

Did this answer your question?