📄️ Quick Start
Overview
📄️ Schema
The Fleetio API uses standard conventions for its architecture:
📄️ Response Codes
These are the most common server responses you will encounter when using the Fleetio API.
📄️ Pagination
The Fleetio API returns data set in pages, instead of all at once. This common API pattern allows us to efficiently return query results without putting unnecessary strain on our resources.
📄️ Filtering and Sorting Results
The Fleetio API supports query parameters for both filtering and sorting results from index endpoints. We have started a transition away from the use of q[] style filtering and sorting towards simpler filter and sort url parameter filtering and sorting. Newer endpoints that accept the filter and sort query parameters will not accept the q[] style filtering parameter.
📄️ Rate Limiting
The Fleetio API is subject to rate limiting to ensure availability and security. Please consult your plan to determine the rate limits for your account.
📄️ Bulk API
Fleetio offers a Bulk API for certain endpoints. Bulk APIs allow you to create data in large batches via a single network request, saving on network overhead.
📄️ Permissions
Fleetio API keys are associated with a single Fleetio user. Each Fleetio User has Role and a set of permissions which limit the actions they can perform on various resources. The same rules that apply to a user via Fleetio web interface, Fleetio Go, and the Fleetio API.
📄️ Custom Fields
Fleetio provides many predefined program fields to store details for various data records. In the case of wanting to track additional information, Custom Fields give you a place to store and report these values.
📄️ Webhooks
Webhooks allow you to listen for events in Fleetio.
📄️ Webhook Event Reference
Below you will find a reference of all webhook events fired from Fleetio. You may subscribe to any of these events from your webhook configuration.
📄️ API Versioning
We want you to be confident that your Fleetio API integration will continue to work even as we make changes to our API. In order to do this, we maintain multiple versions of our API endpoints. This allows us to make breaking changes without breaking your integration. Allowing you to upgrade to the latest version of our API at your own pace, and separately for each endpoint you use.
📄️ API Key Security
Recommendations for keeping your API key secure.
📄️ Date Formatting
When submitting dates to the API, we recommend using the [ISO
📄️ Attaching Documents and Images
Due to the nature of how the Fleetio web app is configured, document and image uploads work a bit differently than our other resources. Files are not uploaded to our API, but directly to our third-party storage provider.