List documents for a account
GET https://services.leadconnectorhq.com/proposals/document
Autorización
Bearer token generado desde el portal Leadway. Ver Autenticación. Version
string
default:"2021-07-28"
required
Versión de la API.
Query parameters
locationId
string
default:"hTlkh7t8gujsahgg93"
required
Account Id
Document status, pass as comma separated values
Payment status, pass as comma separated values
Limit to fetch number of records
dateFrom
string
default:"2025-02-03T18:30:00.000Z"
Date start from (ISO 8601), dateFrom & DateTo must be provided together
dateTo
string
default:"2025-02-14T18:29:59.999Z"
Date to (ISO 8601), dateFrom & DateTo must be provided together
Respuestas
200 - Document fetched successfully
List of documents
locationId
string
default:"hTlkh7t8gujsahgg93"
required
Account Id
documentId
string
default:"hTlkh7t8gujsahgg93"
required
Document Id
_id
string
default:"67ac9a51106ee8311e911XXXX"
required
Unique identifier
name
string
default:"Document Name"
required
Name of the document
type
string
default:"proposal"
required
Type of the document
deleted
boolean
default:"False"
required
Whether the document is deleted
isExpired
boolean
default:"False"
required
Whether the document is expired
documentRevision
number
default:"1"
required
Number of times document is moved to draft state
Fillable fields
fieldId
string
default:"text_field_1"
required
Field Id
isRequired
boolean
default:"True"
required
Is the field required
hasCompleted
boolean
default:"True"
required
Has the field been completed
recipient
string
default:"John Doe"
required
Recipient
Entity type Posibles valores: ‘contacts’, ‘users’
id
string
default:"2d0a6fe1-d519-4198-8785-3da1d7cab925"
required
Id
Element type Posibles valores: ‘Page’, ‘Text’, ‘Image’, ‘Video’, ‘Table’, ‘ProductList’, ‘PageBreak’, ‘Signature’, ‘PaymentDetails’, ‘TextField’, ‘DateField’, ‘InitialsField’, ‘Checkbox’, ‘Row’, ‘Column’
value
string
default:"John Doe"
required
Value of the field
Grand total object of the document
locale
string
default:"en-US"
required
Locale of the account
status
string[]
default:"draft"
required
Document status
paymentStatus
string[]
default:"paid"
required
Payment status
Recipients
id
string
default:"u240JcS0E5qE0ziHnwMm"
required
Recipient Id
email
string
default:"jim@gmail.com"
required
Recipient Email
phoneNumber
string
default:"+1234567890"
Recipient Phone Number
phone
string
default:"1234567890"
Recipient Phone
hasCompleted
boolean
default:"True"
required
Recipient has completed the document
role
string
default:"signer"
required
Recipient role Posibles valores: ‘user’, ‘signer’
isPrimary
boolean
default:"True"
required
Recipient is primary
signingOrder
number
default:"1"
required
Recipient signing order
imgUrl
string
default:"base64 image url"
Recipient image url
ip
string
default:"123.123.123.123"
Recipient ip
signedDate
string
default:"2025-02-03T18:30:00.000Z"
Recipient signed date
contactName
string
default:"Jim Anton"
Recipient contact name
country
string
default:"United States"
Recipient country
entityName
string
default:"Jim Anton"
Recipient entity name
initialsImgUrl
string
default:"base64 image url"
Recipient initials image url
lastViewedAt
string
default:"2025-02-03T18:30:00.000Z"
Recipient last viewed date
shareLink
string
default:"https://www.google.com"
Share link
Links for the document if its sent
referenceId
string
default:"550e8400-e29b-41d4-a716-446655440000"
required
Reference ID
documentId
string
default:"c1e87a91-93b2-4b78-821f-85cf0e1f925b"
required
Document ID
recipientId
string
default:"u240JcS0E5qE0ziHnwMm"
required
Recipient ID
entityName
string
default:"contacts"
required
Entity name that the recipient belongs to Posibles valores: ‘contacts’, ‘users’
recipientCategory
string
default:"recipient"
required
Recipient category (recipient, cc, or bcc) Posibles valores: ‘recipient’, ‘cc’, ‘bcc’
documentRevision
number
default:"1"
required
Document revision number
createdBy
string
default:"b6d8fa28-1112-4dc7-b9d2-f22b75a477ea"
required
Created by user ID
deleted
boolean
default:"False"
required
Whether the document is deleted
updatedAt
string
default:"2025-02-03T18:30:00.000Z"
required
Date start from (ISO 8601)
createdAt
string
default:"2025-02-14T18:29:59.999Z"
required
Date to (ISO 8601)
total
number
default:"10"
required
Total records available
whiteLabelBaseUrl
number
default:"https://example.com"
WhiteLabel url for document
whiteLabelBaseUrlForInvoice
number
default:"https://example.com"
WhiteLabel url for invoice
{
"documents": [
{
"locationId": "hTlkh7t8gujsahgg93",
"documentId": "hTlkh7t8gujsahgg93",
"_id": "67ac9a51106ee8311e911XXXX",
"name": "Document Name",
"type": "proposal",
"deleted": false,
"isExpired": false,
"documentRevision": 1,
"fillableFields": [
{}
],
"locale": "en-US",
"status": "draft",
"paymentStatus": "paid",
"recipients": [
{
"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"
}
],
"links": [
{}
],
"updatedAt": "2025-02-03T18:30:00.000Z",
"createdAt": "2025-02-14T18:29:59.999Z"
}
],
// truncado: 4 lineas mas
}
400 - Unprocessable Entity
message
string
default:"Bad Request"
{
"statusCode": 400,
"message": "Bad Request"
}
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/proposals/document' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/proposals/document', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/proposals/document',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/proposals/document');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
