FieldPulse

FieldPulse Estimates API

Endpoints related to estimates

GitHub OpenAPI
Business capability
Quote & Configuration Management BC-410.40

Operations 6

GET /estimates/{estimateId} Retrieve estimate by ID #
PUT /estimates/{estimateId} Update estimate by ID #
DELETE /estimates/{estimateId} Delete estimate by ID #
GET /estimates/qb-classes Get Estimate QB Classes #
GET /estimates Retrieve estimates list #
POST /estimates Create an estimate #

Documentation

📖
Documentation
https://help.fieldpulse.com/api-reference/overview
📖
GettingStarted
https://help.fieldpulse.com/api-reference/getting-started
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/fieldpulse/refs/heads/main/rate-limits/fieldpulse-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/fieldpulse/refs/heads/main/openapi/fieldpulse-estimates-api-openapi.yml

Other Resources

🔗
Postman
https://documenter.getpostman.com/view/35988189/2sA3XLEjFd
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/fieldpulse/refs/heads/main/asyncapi/fieldpulse-events-webhooks.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/fieldpulse/refs/heads/main/examples/fieldpulse-examples.yml
🔗
Console
https://raw.githubusercontent.com/api-evangelist/fieldpulse/refs/heads/main/sandbox/fieldpulse-sandbox.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/fieldpulse-estimates-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fieldpulse-estimates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: FieldPulse Estimates API
  description: 'REST API for the FieldPulse field service management platform.


    **Authentication:** All requests require an `x-api-key` header. Contact support@fieldpulse.com to obtain your API key.


    **Important:** The API Playground below makes live requests against your production data. Use caution when testing write operations (POST, PUT, DELETE).'
  version: 1.0.0
servers:
- url: https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  description: Production
security:
- apiKeyAuth: []
tags:
- name: Estimates
  description: Endpoints related to estimates
paths:
  /estimates/{estimateId}:
    get:
      tags:
      - Estimates
      summary: Retrieve estimate by ID
      parameters:
      - name: rel[public_link]
        in: query
        schema:
          type: string
        description: For getting single latest public link for the Estimate
      - name: rel[public_links]
        in: query
        schema:
          type: string
        description: For getting all public links for the Estimate
      - name: estimateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              example:
                message: Request URL or object not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                message: Internal Server Error
      operationId: getEstimatesByEstimateId
    put:
      tags:
      - Estimates
      summary: Update estimate by ID
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: {}
      parameters:
      - name: estimateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                error: true
                errors:
                - error message
                - error message
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              example:
                message: Request URL or object not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                message: Internal Server Error
      operationId: putEstimatesByEstimateId
    delete:
      tags:
      - Estimates
      summary: Delete estimate by ID
      parameters:
      - name: estimateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              example:
                message: Request URL or object not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                message: Internal Server Error
      operationId: deleteEstimatesByEstimateId
  /estimates/qb-classes:
    get:
      tags:
      - Estimates
      summary: Get Estimate QB Classes
      parameters:
      - name: active
        in: query
        schema:
          type: string
        description: 'Optional. Values true/false. If true, will return active. If false, will return not active. If not provided, will return all '
        example: <boolean>
      - name: limit
        in: query
        schema:
          type: string
        description: Default 20. Maximum 100
        example: <integer>
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              example:
                message: Request URL not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                message: Internal Server Error
      operationId: getEstimatesQbClasses
  /estimates:
    get:
      tags:
      - Estimates
      summary: Retrieve estimates list
      parameters:
      - name: limit
        in: query
        schema:
          type: string
        description: Defaults to 20 items per page, maximum 100 items allowed.
        example: <string>
      - name: page
        in: query
        schema:
          type: string
        description: Page number. Starts from 1, defaults to 1.
        example: <string>
      - name: sort_by
        in: query
        schema:
          type: string
        description: Value can be any attribute name from the current resource.
        example: <string>
      - name: sort_dir
        in: query
        schema:
          type: string
        description: 'Allowed values: asc, desc'
        example: <string>
      - name: search
        in: query
        schema:
          type: string
        description: Search string.
        example: <string>
      - name: filter
        in: query
        schema:
          type: string
        description: Array of attribute, operator, and value parts.
        example: <array>
      - name: sort
        in: query
        schema:
          type: string
        description: Array of attribute and order values.
        example: <array>
      - name: rel
        in: query
        schema:
          type: string
        description: array consisting of indices with the desired relation to include
        example: <array>
      - name: calculate_count
        in: query
        schema:
          type: string
        description: true or false. If true, in response will be included also total count
        example: <boolean>
      - name: rel[public_link]
        in: query
        schema:
          type: string
        description: For getting single latest public link for the Estimate
      - name: rel[public_links]
        in: query
        schema:
          type: string
        description: For getting all public links for the Estimate
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              example:
                message: Request URL not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                message: Internal Server Error
      operationId: getEstimates
    post:
      tags:
      - Estimates
      summary: Create an estimate
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: {}
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                error: true
                errors:
                - error message
                - error message
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              example:
                message: Request URL not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                message: Internal Server Error
      operationId: postEstimates
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key