ghl_invoice_schedule_get
Retrieves an invoice schedule by schedule ID for a specified location or company, returning the schedule details through the GoHighLevel API.
Instructions
Get an schedule API to get an schedule by schedule id Endpoint: GET /invoices/schedule/{scheduleId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.readonly
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": {
"scheduleId": "<scheduleId>",
"altId": "<altId>",
"altType": "<altType>"
},
"name": "ghl_invoice_schedule_get"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | location Id / company Id based on altType | |
| altType | Yes | Alt Type | |
| scheduleId | Yes | Schedule Id |