API

In this article, you will learn about Onfleet's RESTful API and how to create an API key. 

The Onfleet API is a RESTful web service for developers to programmatically interact with Onfleet's data and real-time delivery management functionality. The complete API documentation is available here. Onfleet also offers additional open-source tooling regarding integrations via the Onfleet API, for more details, please visit our open-source developer repository.

 Note: Full API access is only available in the Basic plan and above. For more info about Onfleet's plans, visit our pricing page.

 

All requests must be authenticated using one of your organization’s API keys. Your organization's administrator can create and maintain API keys through the "API & Webhooks" tab in their dashboard settings.

 

APIkey.png

 

 

Add API Keys

Simply click the + button at the bottom of the API Keys section to create an API key registered with your organization.

 

screenshot-onfleet.com-2020.07.13-17_03_31.png

screenshot-onfleet.com-2020.07.13-17_05_19.png

 

 

API Key Scope

 

To limit the scope of an API key you can select "Limit the scope of this key to the tasks it created" under the key's name. You can update a current key by double-clicking it within the API & Webhooks section of your admin account, or by creating a new key and selecting this option. 

 

4295eba6-616a-46ce-8caf-2ab6ff2e8c30.png

 

An API key with a limited scope can create tasks and only read information pertaining to the tasks created with this key. 

 

 

 

Back to top