Connecting to Onfleet

Onfleet uses HTTP ApiKey Authentication. Your Onfleet API Key is used to authenticate requests. You can generate or view your API Key in the Onfleet dashboard under Settings > API.

Using ApiKey Authentication

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Onfleet API Key.

Example connection string:

Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";

Available Tables

The Onfleet API Profile provides access to delivery operations data across 18 tables:

• Organization - Query your Onfleet organization details and delegation relationships.
• Administrators - Access administrator accounts with role and permission details.
• Workers - Query delivery workers with location, vehicle, and task assignment details.
• Teams - Access delivery teams grouping workers under shared management.
• Tasks - Query delivery tasks with destination, recipient, and completion details.
• Recipients - Access task recipients with contact information; lookup by ID, name, or phone.
• Destinations - Query delivery destinations with address and geolocation details.
• Hubs - Access physical hub locations for team operations.
• OrganizationContainer - Access the task container for your organization.
• WorkerContainers - Query the ordered task container for a specific worker.
• TeamContainers - Access the ordered task container for a specific team.
• WorkersByLocation - Query workers filtered by geographic proximity.
• WorkerTasks - Access delivery tasks assigned to a specific worker.
• WorkerSchedule - Query scheduled work shifts for a specific worker.
• TeamTasks - Access unassigned tasks in a specific team container.
• Orders - Query task orders linking pickup and dropoff tasks for end-to-end tracking.
• RoutePlans - Access route plans organizing workers and tasks into optimized delivery routes.
• TaskBatchJobs - Query batch task creation job status and results.
• RouteOptimizations - Access route optimization job status and results (requires premium plan).

Usage Examples

Administrators:

SELECT * FROM Administrators

Destinations:

SELECT * FROM Destinations WHERE Id = 'destination123'

Hubs:

SELECT * FROM Hubs

Orders:

SELECT * FROM Orders WHERE Id = 'order123'

Organization:

SELECT * FROM Organization

OrganizationContainer:

SELECT * FROM OrganizationContainer WHERE OrganizationId = 'org123'

Recipients:

SELECT * FROM Recipients WHERE Id = 'recipient123'

RouteOptimizations:

SELECT * FROM RouteOptimizations WHERE OptimizationId = 'opt123'

RoutePlans:

SELECT * FROM RoutePlans

TaskBatchJobs:

SELECT * FROM TaskBatchJobs WHERE BatchId = 'batch123'

Tasks:

SELECT * FROM Tasks WHERE StartTime = '2024-01-01T00:00:00'

TeamContainers:

SELECT * FROM TeamContainers WHERE TeamId = 'team123'

Teams:

SELECT * FROM Teams

TeamTasks:

SELECT * FROM TeamTasks WHERE TeamId = 'team123'

WorkerContainers:

SELECT * FROM WorkerContainers WHERE WorkerId = 'worker123'

Workers:

SELECT * FROM Workers

WorkersByLocation:

SELECT * FROM WorkersByLocation WHERE Longitude = -118.2437 AND Latitude = 34.0522

WorkerSchedule:

SELECT * FROM WorkerSchedule WHERE WorkerId = 'worker123'

WorkerTasks:

SELECT * FROM WorkerTasks WHERE WorkerId = 'worker123'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	The API key used to authenticate to Onfleet.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT