For AI agents: visit https://falconflex.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

v1

API Reference

v1API Reference

Getting Started

API Reference Guide
Authorization

Health

Health Statusget

Tasks

Create Taskpost
Create Task Asyncpost
Create Task Async Resultpost
Update Taskput
Cancel Taskpatch
Get All Tasksget
Get Task Infoget
Get Task ETAget
Track Multiple Taskspost

Agents

Create Agentpost
Update Agentpatch
Get All Agentsget
Get Agent Infoget
Make Agent Offlinepost
Modify Agent employmentpost
Send Notification to Agentpost

TRIPS

Create Trip Automaticallypost
Create Trip Manuallypost

Callbacks

Create Callbackpost
Delete Callbackdel
Get All Callbacksget

Zoning

Get All Areasget

Shifts

Create Shiftpost
Update Shiftput
Delete Shiftpost
Get All Shiftsget
Get Shift Infoget
Get Agents in Shiftget
Assign Agents to Shiftpost
Unassign Agentspost

Location Points

Create Location Pointpost
Get All Location Pointsget
Convert Qatar address to Global addressget
Get Distance between Location Pointspost

Wallet Management

Get Agent Balanceget
Get Agent Balance Infoget
Get Agent Ledgerget
Deposit Amountpost
Deduct Amountpost

Powered by

Getting Started

API Reference Guide

This API Reference serves as a guide to integrate your system with the FalconFlex system.

Updated over 3 years ago

Updated over 3 years ago