Skip to main content
DocumentsVersion: v3

List documents

GET/proposals/document

List documents for a location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

locationIdstringrequired

Location Id

Example:hTlkh7t8gujsahgg93
statusstring

Document status, pass as comma separated values

Available optionsdraftsentviewedcompletedaccepted
Example:draft
paymentStatusstring

Payment status, pass as comma separated values

Available optionswaiting_for_paymentpaidno_payment
Example:paid
limitnumber

Limit to fetch number of records

Example:10
skipnumber

Skip number of records

Example:0
querystring

Search string

Example:document
dateFromstring

Date start from (ISO 8601), dateFrom & DateTo must be provided together

Example:2025-02-03T18:30:00.000Z
dateTostring

Date to (ISO 8601), dateFrom & DateTo must be provided together

Example:2025-02-14T18:29:59.999Z

Response

application/json

Document fetched successfully

documentsobject[]required

List of documents

totalnumberrequired

Total records available

Example:10
whiteLabelBaseUrlnumber

WhiteLabel url for document

Example:https://example.com
whiteLabelBaseUrlForInvoicenumber

WhiteLabel url for invoice

Example:https://example.com