FieldPulse's API allows you to interact with our system for creating, reading, updating, and deleting data. This documentation will guide you through using our API effectively.
\nBy accessing or using the FieldPulse API, you agree to FieldPulse's Terms of Service.
\nWith the FieldPulse API, you can access several different endpoints. We also offer webhooks for Job Status changes. Some common examples for using our API include:
\nCollect Customer leads from your website
\nUpdate Invoice statuses from another system
\nCreate and update Invoices
\nCreate Purchase Orders
\nCreate Jobs and update Job statuses
\nUpdate Customer locations
\nAdd Customer tags from another system
\nCreate and update Estimate details
\nIf you're interested in partnering with FieldPulse, please complete the form at http://fieldpulse.com/partners with information about your company and proposed integration.
\nWe have a thorough Help Center that can answer questions regarding FieldPulse functionality. If you have technical issues with the API we can be reached at support@fieldpulse.com.
\n","_postman_id":"42448556-bffc-48f0-99fd-2e15da1a2a0f"},{"name":"🚀 Getting Started","item":[],"id":"74f25fa8-2d09-4a8c-b21e-148099546726","description":"API Endpoints: All operations are performed through specific endpoints. These endpoints are relative to the base URL: https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
\nAuthentication: To access the API, you’ll need an API token. If you don’t have one yet, get in touch with us at support@fieldpulse.com to register and activate your API token. You will include this token in the header of your requests using the key x-api-key.
\n3. HTTP Methods: We use standard HTTP methods in our API.
\n- GET to retrieve resources\n- POST to create resources\n- PUT to update resources\n- DELETE to delete resources\n\n4. Response Format: All responses are returned in JSON format.
\n5. Status Codes: The API uses standard HTTP status codes to indicate success or failure of API requests.
\n- 200 OK: Everything worked as expected\n- 201 Created: Everything worked as expected\n- 202 Accepted: Authentication is passed\n- 400 Bad Request: The request was unacceptable, often due to missing a required parameter or wrong parameter.\n- 401 Unauthorized: for missing/invalid authentication\n- 404 Not Found: for non-existing resources\n- 422 Unprocessable Entity: authentication validation error\n- 500 Internal Server Error: for server errors\n\n6. Rate Limits - The FieldPulse API has rate limits, wich is 50 requests per second , to manage the volume of calls to our API. Once the rate limit is exceeded, subsequent requests will receive an error response with a status 429. 429 responses will include a header (RateLimit-Reset) with the time (in epoch format) that the user rate limit will be reset. If you are exceeding the rate limit regularly, email us to discuss alternative options.
7. Request Data Validation - all POST and PUT requests have data validation rules , which are in the requests body descriptions.
Please make a note,
. optional - means the data is not required
. nullable - means the value can be null
To ensure we're on the same page with our FieldPulse terminology, below are definitions of record types and terminology you'll see throughout the documentation.
\nAssets - Assets are typically physical products sold to customers or equipment used by the business and include data such as warranty information, installation dates, and photos. These are different from invoice items.
\nComments - Comments are used for internal company communication between users on customer records, jobs, invoices, etc.
\nContracts - Contracts can be added to estimates and invoices and require a customer's signature before beginning work.
\nCustomers - The customer is the person for whom the company is performing work.
\nCustom Fields - Custom Fields are customizable fields that can belong to customer records, jobs, invoices, estimates, and purchase orders. They are used to capture custom information and details.
\nEstimates - Estimates (sometimes called quotes) can be created from customer records, jobs, or from the Estimates page directly. They are used to create work proposals for customers and can be converted to invoices. Estimates are often created from Estimate Templates.
\nInvoices - A central part of the FieldPulse platform, invoices are sent by companies to customers to collect payment for work. Invoices are often created using Invoice Templates.
\nInvoice Items - These are the line items that exist on an invoice. They include several fields like name, prices, cost, quantity, vendor, IDs, and much more.
\nJobs - Jobs (also referred to as work orders) are associated with customers and represent a body of work to be completed by a company for a customer. Jobs are often created using Job Templates. Jobs have statuses and typically result in an estimate and invoice.
\nLocations - Addresses on various record types.
\nPayments - Payments are created from invoices. Payment methods can be credit cards, cash, check, or other.
\nPipeline Status - Companies may categorize their customers into pipeline statuses such as new, contact made, scheduled, converted.
\nProjects - Projects can contain jobs, estimates, and invoices. They are typically used to track larger bodies of work that will contain multiple jobs and invoices.
\nPurchase Orders (POs) - Purchase orders can be created as standalone POs or created from jobs, estimates, or invoices directly and are used to purchase materials from suppliers.
\nSubtasks - Projects, jobs, estimates, and invoices can each have subtasks which are used like checklists. Some may be required and some may not, and some may be part of a sequential order.
\nTags - Tags are labels of text that exist on all record types, used for categorization and organization of records.
\nTeams - Teams are groups of company users. A user may belong to more than one team. Teams are often used to assign work to a group of users.
\nTimesheets - Timesheets are used to clock users in and out and to calculate pay and hours worked.
\nUsers - Company users. We currently have three roles: Admin, Team Manager, and Service Agent. The permissions for each role are highly customizable.
\nVendors - Typically used on purchase orders or inventory items to specify the manufacturer or supplier.
\n","_postman_id":"5379f0f5-6de3-4579-b09d-6cfe10ef891e"},{"name":"assets","item":[{"name":"{id}","item":[{"name":"Retrieve asset by ID","id":"b007d99f-bdc7-43a5-b2a5-9dc13615cf44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"x-api-key","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"