# List documents GET https://services.leadconnectorhq.com/proposals/document List documents for a location ## Authentication Send `Authorization: Bearer ` using any one of: - **Sub-Account token: OAuth access token or Private Integration Token.** No scopes required. - **Agency token: OAuth access token or Private Integration Token.** No scopes required. ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `locationId` | string | Yes | Location Id | | `status` | string | No | Document status, pass as comma separated values | | `paymentStatus` | string | No | Payment status, pass as comma separated values | | `limit` | number | No | Limit to fetch number of records | | `skip` | number | No | Skip number of records | | `query` | string | No | Search string | | `dateFrom` | string | No | Date start from (ISO 8601), dateFrom & DateTo must be provided together | | `dateTo` | string | No | Date to (ISO 8601), dateFrom & DateTo must be provided together | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/proposals/document": { "get": { "summary": "List documents", "operationId": "listDocuments", "description": "List documents for a location", "parameters": [ { "name": "locationId", "required": true, "in": "query", "description": "Location Id", "schema": { "example": "hTlkh7t8gujsahgg93", "type": "string" } }, { "name": "status", "required": false, "in": "query", "description": "Document status, pass as comma separated values", "schema": { "example": "draft", "enum": [ "draft", "sent", "viewed", "completed", "accepted" ], "type": "string" } }, { "name": "paymentStatus", "required": false, "in": "query", "description": "Payment status, pass as comma separated values", "schema": { "example": "paid", "enum": [ "waiting_for_payment", "paid", "no_payment" ], "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Limit to fetch number of records", "schema": { "example": 10, "type": "number" } }, { "name": "skip", "required": false, "in": "query", "description": "Skip number of records", "schema": { "example": 0, "type": "number" } }, { "name": "query", "required": false, "in": "query", "description": "Search string", "schema": { "example": "document", "type": "string" } }, { "name": "dateFrom", "required": false, "in": "query", "description": "Date start from (ISO 8601), dateFrom & DateTo must be provided together", "schema": { "example": "2025-02-03T18:30:00.000Z", "type": "string" } }, { "name": "dateTo", "required": false, "in": "query", "description": "Date to (ISO 8601), dateFrom & DateTo must be provided together", "schema": { "example": "2025-02-14T18:29:59.999Z", "type": "string" } }, { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } } ], "responses": { "200": { "description": "Document fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentListResponseDto" } } } }, "400": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } } }, "security": [ { "Location-Access": [] }, { "Agency-Access": [] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" } }, "schemas": { "DocumentListResponseDto": { "type": "object", "properties": { "documents": { "description": "List of documents", "type": "array", "items": { "type": "object", "properties": { "locationId": { "type": "string", "description": "Location Id", "example": "hTlkh7t8gujsahgg93" }, "documentId": { "type": "string", "description": "Document Id", "example": "hTlkh7t8gujsahgg93" }, "_id": { "type": "string", "description": "Unique identifier", "example": "67ac9a51106ee8311e911XXXX" }, "name": { "type": "string", "description": "Name of the document", "example": "Document Name" }, "type": { "type": "string", "description": "Type of the document", "example": "proposal" }, "deleted": { "type": "boolean", "description": "Whether the document is deleted", "example": false }, "isExpired": { "type": "boolean", "description": "Whether the document is expired", "example": false }, "documentRevision": { "type": "number", "description": "Number of times document is moved to draft state", "example": 1 }, "fillableFields": { "description": "Fillable fields", "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "Field Id", "example": "text_field_1" }, "isRequired": { "type": "boolean", "description": "Is the field required", "example": true }, "hasCompleted": { "type": "boolean", "description": "Has the field been completed", "example": true }, "recipient": { "type": "string", "description": "Recipient", "example": "John Doe" }, "entityType": { "type": "string", "description": "Entity type", "enum": [ "contacts", "users" ], "title": "EntityReference" }, "id": { "type": "string", "description": "Id", "example": "2d0a6fe1-d519-4198-8785-3da1d7cab925" }, "type": { "example": "TextField", "type": "string", "description": "Element type", "enum": [ "Page", "Text", "Image", "Video", "Table", "ProductList", "PageBreak", "Signature", "PaymentDetails", "TextField", "DateField", "InitialsField", "Checkbox", "Row", "Column" ], "title": "ELEMENTS_LOOKUP" }, "value": { "type": "string", "description": "Value of the field", "example": "John Doe" } }, "required": [ "fieldId", "isRequired", "hasCompleted", "recipient", "entityType", "id", "type", "value" ], "title": "FillableFieldsDTO" } }, "grandTotal": { "description": "Grand total object of the document", "allOf": [ { "type": "object", "properties": { "amount": { "type": "number", "example": 100, "description": "Total amount before discounts" }, "currency": { "type": "string", "example": "USD", "description": "Currency of the total amount" }, "discountPercentage": { "type": "number", "example": 15, "description": "Total discount percentage applied" }, "discounts": { "description": "List of applied discounts", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "123456", "description": "Unique identifier for the discount" }, "value": { "type": "number", "example": 10, "description": "Discount value (either a percentage or custom amount)" }, "type": { "type": "string", "example": "percentage", "enum": [ "percentage", "custom_amount" ], "description": "Type of discount" } }, "required": [ "id", "value", "type" ], "title": "DiscountDto" } } }, "required": [ "amount", "currency", "discountPercentage", "discounts" ], "title": "GrandTotalDto" } ] }, "locale": { "type": "string", "description": "Locale of the location", "example": "en-US" }, "status": { "type": "array", "description": "Document status", "example": "draft", "items": { "type": "string", "enum": [ "draft", "sent", "viewed", "completed", "accepted" ] } }, "paymentStatus": { "type": "array", "description": "Payment status", "example": "paid", "items": { "type": "string", "enum": [ "waiting_for_payment", "paid", "no_payment" ] } }, "recipients": { "description": "Recipients", "example": [ { "id": "u240JcS0E5qE0ziHnwMm", "email": "jim@gmail.com", "imageUrl": "", "contactName": "Jim Anton", "firstName": "Jim", "lastName": "Anton", "role": "signer", "hasCompleted": true, "signingOrder": 1, "imgUrl": "base64 image url", "ip": "123.123.123.123" } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Recipient Id", "example": "u240JcS0E5qE0ziHnwMm" }, "firstName": { "type": "string", "description": "Recipient First Name", "example": "Jim" }, "lastName": { "type": "string", "description": "Recipient Last Name", "example": "Anton" }, "email": { "type": "string", "description": "Recipient Email", "example": "jim@gmail.com" }, "phoneNumber": { "type": "string", "description": "Recipient Phone Number", "example": "+1234567890" }, "phone": { "type": "string", "description": "Recipient Phone", "example": "1234567890" }, "hasCompleted": { "type": "boolean", "description": "Recipient has completed the document", "example": true }, "role": { "type": "string", "enum": [ "user", "signer" ], "description": "Recipient role", "example": "signer" }, "isPrimary": { "type": "boolean", "description": "Recipient is primary", "example": true }, "signingOrder": { "type": "number", "description": "Recipient signing order", "example": 1 }, "imgUrl": { "type": "string", "description": "Recipient image url", "example": "base64 image url" }, "ip": { "type": "string", "description": "Recipient ip", "example": "123.123.123.123" }, "userAgent": { "type": "string", "description": "Recipient user agent", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36" }, "signedDate": { "type": "string", "description": "Recipient signed date", "example": "2025-02-03T18:30:00.000Z" }, "contactName": { "type": "string", "description": "Recipient contact name", "example": "Jim Anton" }, "country": { "type": "string", "description": "Recipient country", "example": "United States" }, "entityName": { "type": "string", "description": "Recipient entity name", "example": "Jim Anton" }, "initialsImgUrl": { "type": "string", "description": "Recipient initials image url", "example": "base64 image url" }, "lastViewedAt": { "type": "string", "description": "Recipient last viewed date", "example": "2025-02-03T18:30:00.000Z" }, "shareLink": { "type": "string", "description": "Share link", "example": "https://www.google.com" } }, "required": [ "id", "email", "hasCompleted", "role", "isPrimary", "signingOrder" ], "title": "RecipientItem" } }, "links": { "description": "Links for the document if its sent", "type": "array", "items": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "Reference ID", "example": "550e8400-e29b-41d4-a716-446655440000" }, "documentId": { "type": "string", "description": "Document ID", "example": "c1e87a91-93b2-4b78-821f-85cf0e1f925b" }, "recipientId": { "type": "string", "description": "Recipient ID", "example": "u240JcS0E5qE0ziHnwMm" }, "entityName": { "type": "string", "enum": [ "contacts", "users" ], "description": "Entity name that the recipient belongs to", "example": "contacts" }, "recipientCategory": { "type": "string", "enum": [ "recipient", "cc", "bcc" ], "description": "Recipient category (recipient, cc, or bcc)", "example": "recipient" }, "documentRevision": { "type": "number", "description": "Document revision number", "example": 1 }, "createdBy": { "type": "string", "description": "Created by user ID", "example": "b6d8fa28-1112-4dc7-b9d2-f22b75a477ea" }, "deleted": { "type": "boolean", "description": "Whether the document is deleted", "example": false } }, "required": [ "referenceId", "documentId", "recipientId", "entityName", "recipientCategory", "documentRevision", "createdBy", "deleted" ], "title": "ProposalEstimateLinksDto" } }, "updatedAt": { "type": "string", "description": "Date start from (ISO 8601)", "example": "2025-02-03T18:30:00.000Z" }, "createdAt": { "type": "string", "description": "Date to (ISO 8601)", "example": "2025-02-14T18:29:59.999Z" } }, "required": [ "locationId", "documentId", "_id", "name", "type", "deleted", "isExpired", "documentRevision", "fillableFields", "grandTotal", "locale", "status", "paymentStatus", "recipients", "links", "updatedAt", "createdAt" ], "title": "DocumentDto" } }, "total": { "type": "number", "description": "Total records available", "example": 10 }, "whiteLabelBaseUrl": { "type": "number", "description": "WhiteLabel url for document", "example": "https://example.com" }, "whiteLabelBaseUrlForInvoice": { "type": "number", "description": "WhiteLabel url for invoice", "example": "https://example.com" } }, "required": [ "documents", "total" ], "title": "DocumentListResponseDto" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/proposals/document?locationId=' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v3' } }; try { const response = await fetch('https://services.leadconnectorhq.com/proposals/document?locationId=', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/proposals/document" headers = { "Authorization": "Bearer ", "Version": "v3" } params = { "locationId": "" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/proposals/document?locationId=', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/proposals/document?locationId=") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/proposals/document?locationId=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/proposals/document?locationId=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/proposals/document?locationId=' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```