ghl_proposal_list_documents
Lists proposal documents for a specific location, with pagination and filters for status, payment status, dates, and search query.
Instructions
List documents List documents for a location Endpoint: GET /proposals/document (Version header: v3; source: v3/proposals-v3.json) Requires an Agency or Sub-Account token. Pagination params: limit, skip — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"locationId": "<locationId>"
},
"name": "ghl_proposal_list_documents"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Skip number of records | |
| limit | No | Limit to fetch number of records | |
| query | No | Search string | |
| dateTo | No | Date to (ISO 8601), dateFrom & DateTo must be provided together | |
| status | No | Document status, pass as comma separated values | |
| dateFrom | No | Date start from (ISO 8601), dateFrom & DateTo must be provided together | |
| locationId | Yes | Location Id | |
| paymentStatus | No | Payment status, pass as comma separated values |