Get Contact Renewals
Retrieve contact renewal reminder records from FleetIO, such as license renewals and certifications.
Operation
Section titled “Operation”getRenewals
Resource
Section titled “Resource”contactRenewal
Parameters
Section titled “Parameters”This operation has no required parameters.
Options
Section titled “Options”| Option | Type | Default | Description |
|---|---|---|---|
| Include Debug Info | boolean | false | Whether to include metadata about the API request |
Response
Section titled “Response”Success
Section titled “Success”Returns an array of contact renewal records:
{ "id": 12345, "contact_id": 789, "contact_name": "John Smith", "contact_renewal_type_id": 1, "contact_renewal_type_name": "CDL License", "due_date": "2025-06-15", "due_soon_threshold_in_days": 30, "overdue": false, "due_soon": true, "notes": "Renewal reminder for CDL license"}{ "success": false, "error": "FleetIO credential is missing apiKey"}Response Fields
Section titled “Response Fields”| Field | Type | Description |
|---|---|---|
| id | number | Unique renewal ID |
| contact_id | number | Associated contact ID |
| contact_name | string | Contact name |
| contact_renewal_type_id | number | Renewal type ID |
| contact_renewal_type_name | string | Renewal type name |
| due_date | string | Due date for renewal |
| due_soon_threshold_in_days | number | Days before due to trigger alert |
| overdue | boolean | Whether renewal is overdue |
| due_soon | boolean | Whether renewal is due soon |
| notes | string | Additional notes |
Error Handling
Section titled “Error Handling”- Missing API URL: FleetIO credential is missing apiUrl
- Missing Account Token: FleetIO credential is missing accountToken
- Missing API Key: FleetIO credential is missing apiKey
- Rate Limiting: API rate limit exceeded