List documents for a account
Autorización
Bearer token generado desde el portal Leadway. Ver Autenticación. string
default:"2021-07-28"
required
Versión de la API.
Query parameters
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
string
default:"2025-02-03T18:30:00.000Z"
Date start from (ISO 8601), dateFrom & DateTo must be provided together
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
string
default:"hTlkh7t8gujsahgg93"
required
Account Id
string
default:"hTlkh7t8gujsahgg93"
required
Document Id
string
default:"67ac9a51106ee8311e911XXXX"
required
Unique identifier
string
default:"Document Name"
required
Name of the document
string
default:"proposal"
required
Type of the document
boolean
default:"False"
required
Whether the document is deleted
boolean
default:"False"
required
Whether the document is expired
number
default:"1"
required
Number of times document is moved to draft state
Fillable fields
string
default:"text_field_1"
required
Field Id
boolean
default:"True"
required
Is the field required
boolean
default:"True"
required
Has the field been completed
string
default:"John Doe"
required
Recipient
Entity type Posibles valores: ‘contacts’, ‘users’
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’
string
default:"John Doe"
required
Value of the field
Grand total object of the document
string
default:"en-US"
required
Locale of the account
string[]
default:"draft"
required
Document status
string[]
default:"paid"
required
Payment status
Recipients
string
default:"u240JcS0E5qE0ziHnwMm"
required
Recipient Id
string
default:"jim@gmail.com"
required
Recipient Email
string
default:"+1234567890"
Recipient Phone Number
string
default:"1234567890"
Recipient Phone
boolean
default:"True"
required
Recipient has completed the document
string
default:"signer"
required
Recipient role Posibles valores: ‘user’, ‘signer’
boolean
default:"True"
required
Recipient is primary
number
default:"1"
required
Recipient signing order
string
default:"base64 image url"
Recipient image url
string
default:"123.123.123.123"
Recipient ip
string
default:"2025-02-03T18:30:00.000Z"
Recipient signed date
string
default:"Jim Anton"
Recipient contact name
string
default:"United States"
Recipient country
string
default:"Jim Anton"
Recipient entity name
string
default:"base64 image url"
Recipient initials image url
string
default:"2025-02-03T18:30:00.000Z"
Recipient last viewed date
string
default:"https://www.google.com"
Share link
Links for the document if its sent
string
default:"550e8400-e29b-41d4-a716-446655440000"
required
Reference ID
string
default:"c1e87a91-93b2-4b78-821f-85cf0e1f925b"
required
Document ID
string
default:"u240JcS0E5qE0ziHnwMm"
required
Recipient ID
string
default:"contacts"
required
Entity name that the recipient belongs to Posibles valores: ‘contacts’, ‘users’
string
default:"recipient"
required
Recipient category (recipient, cc, or bcc) Posibles valores: ‘recipient’, ‘cc’, ‘bcc’
number
default:"1"
required
Document revision number
string
default:"b6d8fa28-1112-4dc7-b9d2-f22b75a477ea"
required
Created by user ID
boolean
default:"False"
required
Whether the document is deleted
string
default:"2025-02-03T18:30:00.000Z"
required
Date start from (ISO 8601)
string
default:"2025-02-14T18:29:59.999Z"
required
Date to (ISO 8601)
number
default:"10"
required
Total records available
number
default:"https://example.com"
WhiteLabel url for document
number
default:"https://example.com"
WhiteLabel url for invoice
400 - Unprocessable Entity
string
default:"Bad Request"
Ejemplo
