API Docs

DEVELOPER PLATFORM

Build on top of your quoting workflow.

Read requests and quotes from Quote Sprocket, synchronize reporting, and prepare integrations with scheduling, accounting, or AI tools.

API operationalBase URLhttps://quotesprocket.com/api/v1

SECURITY

Authentication

Owners and admins create API keys in Settings → Integrations. Send the secret as a Bearer token. Secrets begin with qsp_live_, are displayed once, and are stored as hashes.

Authorization: Bearer qsp_live_••••••••••••••••
requests:readList service requestsquotes:readList quote records

FIRST REQUEST

Quick start

Choose an example, replace the environment variable with your secret, and request your newest leads.

curl "https://quotesprocket.com/api/v1/requests?stage=new&limit=20" \
  -H "Authorization: Bearer $QUOTESPROCKET_API_KEY"

ENDPOINT

GET/requests

List requests

Returns service requests ordered by most recently updated.

Requires requests:read

Query parameters

stagestringOptional

new, review, quoted, won, or lost

limitintegerOptional

1–100; defaults to 20

Example response

{
  "data": [
    {
      "id": "b893…",
      "reference": "QS-1042",
      "service": "Stump removal",
      "summary": "Remove two backyard stumps",
      "stage": "new",
      "assigned_to": null,
      "created_at": "2026-08-19T14:22:10.000Z",
      "updated_at": "2026-08-19T14:22:10.000Z"
    }
  ],
  "meta": { "has_more": false, "next_cursor": null }
}

ENDPOINT

GET/quotes

List quotes

Returns quote records ordered by most recently updated. Money is returned in minor units.

Requires quotes:read

Query parameters

statusstringOptional

draft, sent, viewed, accepted, declined, or expired

limitintegerOptional

1–100; defaults to 20

Example response

{
  "data": [
    {
      "id": "76ee…",
      "reference": "QS-Q-2041",
      "status": "sent",
      "total_minor": 47500,
      "currency": "USD",
      "request_id": "b893…",
      "sent_at": "2026-08-19T15:04:00.000Z",
      "viewed_at": null,
      "accepted_at": null,
      "created_at": "2026-08-19T14:58:00.000Z",
      "updated_at": "2026-08-19T15:04:00.000Z"
    }
  ],
  "meta": { "has_more": false, "next_cursor": null }
}

EVENT CATALOG

Webhook events

GET /webhook-events lists the event names reserved by the platform. Endpoint configuration and outbound delivery are still planned, so no webhook should be treated as active yet.

request.createdrequest.stage_changedquote.createdquote.sentquote.acceptedquote.declined

RESPONSE HANDLING

Errors

Errors use a stable machine-readable code, a human-readable message, and a request ID for support.

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Provide an active API key with requests:read scope."
  },
  "request_id": "api_18db…"
}
400INVALID_STAGEA filter value is invalid.401UNAUTHORIZEDThe key is missing, revoked, invalid, or lacks scope.405READ_ONLY_KEYA write was attempted during the beta.

REFERENCE

Conventions

Version
Responses include X-QuoteSprocket-API-Version: 2026-08-17.
Money
Integer minor units plus an ISO 4217 currency code. 47500 USD means $475.00.
Timestamps
ISO 8601 strings in UTC.
Pagination
Use limit today. Cursor fields are reserved but next_cursor is currently null.
Customer privacy
The beta list endpoints intentionally omit customer contact details.