> ## Documentation Index
> Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List documents
> List documents for a account
List documents for a account
```http theme={null}
GET https://services.leadconnectorhq.com/proposals/document
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
Account Id
Document status, pass as comma separated values
Payment status, pass as comma separated values
Limit to fetch number of records
Skip number of records
Search string
Date start from (ISO 8601), dateFrom & DateTo must be provided together
Date to (ISO 8601), dateFrom & DateTo must be provided together
## Respuestas
List of documents
Account Id
Document Id
Unique identifier
Name of the document
Type of the document
Whether the document is deleted
Whether the document is expired
Number of times document is moved to draft state
Fillable fields
Field Id
Is the field required
Has the field been completed
Recipient
Entity type Posibles valores: 'contacts', 'users'
Id
Element type Posibles valores: 'Page', 'Text', 'Image', 'Video', 'Table', 'ProductList', 'PageBreak', 'Signature', 'PaymentDetails', 'TextField', 'DateField', 'InitialsField', 'Checkbox', 'Row', 'Column'
Value of the field
Grand total object of the document
Locale of the account
Document status
Payment status
Recipients
Recipient Id
Recipient First Name
Recipient Last Name
Recipient Email
Recipient Phone Number
Recipient Phone
Recipient has completed the document
Recipient role Posibles valores: 'user', 'signer'
Recipient is primary
Recipient signing order
Recipient image url
Recipient ip
Recipient user agent
Recipient signed date
Recipient contact name
Recipient country
Recipient entity name
Recipient initials image url
Recipient last viewed date
Share link
Links for the document if its sent
Reference ID
Document ID
Recipient ID
Entity name that the recipient belongs to Posibles valores: 'contacts', 'users'
Recipient category (recipient, cc, or bcc) Posibles valores: 'recipient', 'cc', 'bcc'
Document revision number
Created by user ID
Whether the document is deleted
Date start from (ISO 8601)
Date to (ISO 8601)
Total records available
WhiteLabel url for document
WhiteLabel url for invoice
```json theme={null}
{
"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
}
```
```json theme={null}
{
"statusCode": 400,
"message": "Bad Request"
}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/proposals/document' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
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();
```
```python Python theme={null}
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 PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```