QuoteWerks REST API [BETA]

API Documentation

Interactive API documentation with request/response examples, authentication details, and the ability to test endpoints directly in your browser.

Open Swagger UI

REST API — JSON:API Specification

Follows the JSON:API specification for querying QuoteWerks data. Supports pagination, filtering, sorting, sparse fieldsets, and relationship sideloading.

GET /api/v1/qw/tables GET /api/v1/qw/tables/{table}/schema GET /api/v1/qw/tables/{table} GET /api/v1/qw/tables/{table}/{id}

JSON:API resource format (type, id, attributes)

Pagination with page[number], page[size], and links

Filtering with filter[objects] JSON

Sorting with sort parameter

Sparse fieldsets with fields[Type]=field1,field2

Relationship sideloading with ?include=DocumentItems

OData v4

OData v4 compliant endpoints for BI tool integration (Power BI, Excel, Tableau). Supports $filter, $select, $orderby, $expand, and $count.

GET /odata/v4 GET /odata/v4/$metadata GET /odata/v4/{EntitySet} GET /odata/v4/{EntitySet}({key})

Service document discovery

EDMX metadata for schema

$expand for related entities

Power BI / Excel compatible

Authentication

All endpoints require authentication via OAuth 2.0 bearer token, API key (X-API-Key header), or HTTP Basic Auth. See the Authentication section in the API documentation for details.