Business Organization Management API - Production

Generate access token Get org details Create org Delete org

Business Receipts API - Production

Business Invoice Get Receipt (per trip)Business receipt PDF Generate Access Token

Business Receipts API - Sandbox

Generate Access Token

Create Run Get Run

Get Trip Invoice PDF Get Trip Receipt Get Trip Receipt PDF

Employee Management API - Sandbox

Search Employees Get Employee Get Groups Update Employee Delete Employee Generate Access Token Create Employee List All Employees Invite Employees

Employee Trips v2 API - Sandbox

9d. Change Driver State (CANCEL)Receipt Access token 7. Get Zones (optional) place ID 11. Delete Trip 7. Get Zones (optional) address Get Address 2. Create Run (for sandbox only)4. Get Programs GET Receipt 8. Create Trip 3. Get Run (for sandbox only)7. Get Zones (optional)6. Get Estimates Update 10. Get trip by trip ID

Guest Rides API - Production

1. Generate Access Token

2c. Get Trip Estimate - Flexible Ride

4d. Create a Trip - Reserve

List & Get Trips

7b. List all Guest trips - Default ACTIVE trips 5. Get Trip BY trip ID

Initiate Communication

9. Initiate Driver/Recipient Phone Call 10. Establishing one way communication

6. Cancel a Trip

Guest Rides API - Sandbox

1. Generate Access Token

4. Get Zones 2. Create Run 3. Get Run

5d. Get Trip Estimate - Reserve Ride

6d. Create Trip - Reserve Ride

Change Driver State

7. Change Driver State

List & Get Trips

9b. List All Trips - PAST 8. Get Trip by Trip ID

10. Cancel Trip by Trip ID

Scenarios-Run Collection No Drivers Available-Authorization

1. Generate Access Token

Scenarios-Run Collection No Drivers Available-Run & Zones

3. Get Run 2. Create Run

Scenarios-Run Collection No Drivers Available-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection No Drivers Available-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection No Drivers Available-List & Get Trips

6. Get Trip by Trip ID

Scenarios-Run Collection On Demand-Authorization

1. Generate Access Token

Scenarios-Run Collection On Demand-Create and Get Run

3. Get Run 2. Create Run

Scenarios-Run Collection On Demand-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection On Demand-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection On Demand-Change Driver State

6. Change Driver State - Completed

Scenarios-Run Collection On Demand-Get Guest Trip

7. Get Trip by Trip ID

Scenarios-Run Collection Redispatch Flow-Authorization

1. Generate Access Token

Scenarios-Run Collection Redispatch Flow-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Redispatch Flow-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection Redispatch Flow-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection Redispatch Flow-Change Driver State

6. Change Driver State - Completed

Scenarios-Run Collection Redispatch Flow-Get Guest Trip

7. Get Trip by Trip ID

Scenarios-Run Collection Driver Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Driver Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Driver Cancel-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection Driver Cancel-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection Driver Cancel-Change Driver State

6. Change Driver State - Cancel

Scenarios-Run Collection Driver Cancel-Get Guest Trip

7. Get Trip by Trip ID

Scenarios-Run Collection Coordinator Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Coordinator Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Coordinator Cancel-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection Coordinator Cancel-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection Coordinator Cancel-Change Driver State

6. Change Driver State - Arrive

Scenarios-Run Collection Coordinator Cancel-Cancel Guest Trip

7. Cancel Health Trip

Scenarios-Run Collection Coordinator Cancel-Get Guest Trip

8. Get Trip by Trip ID

Health API - Production

1. Generate Access Token

2.c Get Health Trip Estimates - Flexible

Create Health Trip

3.c Create Health Trip - Flexible

Get Health Trip

4.b Get All Active Health Trips 4.a Get Health Trip by ID

Cancel Health Trip

5. Cancel Health Trip

Get Request Zones

Get Request Zones

Health API - Sandbox

1. Generate Access Token

4.Get Request Zones 3. Get Run 2. Create Run

5b. Get Health Trip Estimates - Scheduled 5d. Get Health Trip Estimates - Reserve

Create Health Trip

6d. Create Health Trip - Reserve

Change Driver State

7. Change Driver State

Get Health Trips

8. Get Health Trip By Trip ID 9a. List All Active Trips

Cancel Health Trips

10. Cancel Health Trip

Scenarios-Run Collection Coordinator Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Coordinator Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Coordinator Cancel-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection Coordinator Cancel-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection Coordinator Cancel-Change Driver State

6. Change Driver State - ARRIVED

Scenarios-Run Collection Coordinator Cancel-Cancel Health Trips

7. Cancel Health Trip

Scenarios-Run Collection Coordinator Cancel-Get Health Trips

8. Get Health Trip By Trip ID

Scenarios-Run Collection Driver Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Driver Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Driver Cancel-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection Driver Cancel-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection Driver Cancel-Change Driver State

6. Change Driver State - CANCEL

Scenarios-Run Collection Driver Cancel-Get Health Trips

7. Get Health Trip By Trip ID

Scenarios-Run Collection No Drivers Avaialable-Authorization

1. Generate Access Token

Scenarios-Run Collection No Drivers Avaialable-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection No Drivers Avaialable-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection No Drivers Avaialable-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection No Drivers Avaialable-Get Health Trips

6. Get Health Trip By Trip ID

Scenarios-Run Collection On Demand-Authorization

1. Generate Access Token

Scenarios-Run Collection On Demand-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection On Demand-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection On Demand-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection On Demand-Change Driver State

6. Change Driver State - DROPOFF

Scenarios-Run Collection On Demand-Get Health Trips

7. Get Health Trip By Trip ID

Vouchers API - Production

Generate Access Token (client_credentials)

Voucher program creation: Without Template

Create Voucher Program

Voucher program creation: With Template

Create Voucher Template Create Voucher Program From Template

Voucher Program Managment

Cancel Voucher Program Search Voucher Programs Update Voucher Program Get Voucher Program

Voucher Code Managment

Get Voucher Codes Generate Voucher Codes Cancel Voucher Codes

Voucher Redemption and Comms

Add Guest Bulk Distribution of Voucher Redemption Codes Redeem Voucher Code

Vouchers API - Sandbox

Generate Access Token (client_credentials)

Voucher program creation: Without Template

Create Voucher Program

Voucher program creation: With Template

Create Voucher Program From Template Create Voucher Template

Voucher Program Managment

Get Voucher Program Cancel Voucher Program Search Voucher Programs Update Voucher Program

Voucher Code Managment

Generate Voucher Codes Get Voucher Codes Cancel Voucher Codes

Voucher Redemption and Comms

Redeem Voucher Code Bulk Distribution of Voucher Redemption Codes Add Guest

Create Run GET Run

Business Organization Management API - Production

Generate access token Get org details Create org Delete org

Business Receipts API - Production

Business Invoice Get Receipt (per trip)Business receipt PDF Generate Access Token

Business Receipts API - Sandbox

Generate Access Token

Create Run Get Run

Get Trip Invoice PDF Get Trip Receipt Get Trip Receipt PDF

Employee Management API - Sandbox

Search Employees Get Employee Get Groups Update Employee Delete Employee Generate Access Token Create Employee List All Employees Invite Employees

Employee Trips v2 API - Sandbox

9d. Change Driver State (CANCEL)Receipt Access token 7. Get Zones (optional) place ID 11. Delete Trip 7. Get Zones (optional) address Get Address 2. Create Run (for sandbox only)4. Get Programs GET Receipt 8. Create Trip 3. Get Run (for sandbox only)7. Get Zones (optional)6. Get Estimates Update 10. Get trip by trip ID

Guest Rides API - Production

1. Generate Access Token

2c. Get Trip Estimate - Flexible Ride

4d. Create a Trip - Reserve

List & Get Trips

7b. List all Guest trips - Default ACTIVE trips 5. Get Trip BY trip ID

Initiate Communication

9. Initiate Driver/Recipient Phone Call 10. Establishing one way communication

6. Cancel a Trip

Guest Rides API - Sandbox

1. Generate Access Token

4. Get Zones 2. Create Run 3. Get Run

5d. Get Trip Estimate - Reserve Ride

6d. Create Trip - Reserve Ride

Change Driver State

7. Change Driver State

List & Get Trips

9b. List All Trips - PAST 8. Get Trip by Trip ID

10. Cancel Trip by Trip ID

Scenarios-Run Collection No Drivers Available-Authorization

1. Generate Access Token

Scenarios-Run Collection No Drivers Available-Run & Zones

3. Get Run 2. Create Run

Scenarios-Run Collection No Drivers Available-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection No Drivers Available-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection No Drivers Available-List & Get Trips

6. Get Trip by Trip ID

Scenarios-Run Collection On Demand-Authorization

1. Generate Access Token

Scenarios-Run Collection On Demand-Create and Get Run

3. Get Run 2. Create Run

Scenarios-Run Collection On Demand-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection On Demand-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection On Demand-Change Driver State

6. Change Driver State - Completed

Scenarios-Run Collection On Demand-Get Guest Trip

7. Get Trip by Trip ID

Scenarios-Run Collection Redispatch Flow-Authorization

1. Generate Access Token

Scenarios-Run Collection Redispatch Flow-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Redispatch Flow-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection Redispatch Flow-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection Redispatch Flow-Change Driver State

6. Change Driver State - Completed

Scenarios-Run Collection Redispatch Flow-Get Guest Trip

7. Get Trip by Trip ID

Scenarios-Run Collection Driver Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Driver Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Driver Cancel-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection Driver Cancel-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection Driver Cancel-Change Driver State

6. Change Driver State - Cancel

Scenarios-Run Collection Driver Cancel-Get Guest Trip

7. Get Trip by Trip ID

Scenarios-Run Collection Coordinator Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Coordinator Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Coordinator Cancel-Trip Estimate

4a. Get Trip Estimate - On Demand Ride

Scenarios-Run Collection Coordinator Cancel-Create Trip

5a. Create Trip - On Demand Ride

Scenarios-Run Collection Coordinator Cancel-Change Driver State

6. Change Driver State - Arrive

Scenarios-Run Collection Coordinator Cancel-Cancel Guest Trip

7. Cancel Health Trip

Scenarios-Run Collection Coordinator Cancel-Get Guest Trip

8. Get Trip by Trip ID

Health API - Production

1. Generate Access Token

2.c Get Health Trip Estimates - Flexible

Create Health Trip

3.c Create Health Trip - Flexible

Get Health Trip

4.b Get All Active Health Trips 4.a Get Health Trip by ID

Cancel Health Trip

5. Cancel Health Trip

Get Request Zones

Get Request Zones

Health API - Sandbox

1. Generate Access Token

4.Get Request Zones 3. Get Run 2. Create Run

5b. Get Health Trip Estimates - Scheduled 5d. Get Health Trip Estimates - Reserve

Create Health Trip

6d. Create Health Trip - Reserve

Change Driver State

7. Change Driver State

Get Health Trips

8. Get Health Trip By Trip ID 9a. List All Active Trips

Cancel Health Trips

10. Cancel Health Trip

Scenarios-Run Collection Coordinator Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Coordinator Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Coordinator Cancel-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection Coordinator Cancel-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection Coordinator Cancel-Change Driver State

6. Change Driver State - ARRIVED

Scenarios-Run Collection Coordinator Cancel-Cancel Health Trips

7. Cancel Health Trip

Scenarios-Run Collection Coordinator Cancel-Get Health Trips

8. Get Health Trip By Trip ID

Scenarios-Run Collection Driver Cancel-Authorization

1. Generate Access Token

Scenarios-Run Collection Driver Cancel-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection Driver Cancel-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection Driver Cancel-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection Driver Cancel-Change Driver State

6. Change Driver State - CANCEL

Scenarios-Run Collection Driver Cancel-Get Health Trips

7. Get Health Trip By Trip ID

Scenarios-Run Collection No Drivers Avaialable-Authorization

1. Generate Access Token

Scenarios-Run Collection No Drivers Avaialable-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection No Drivers Avaialable-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection No Drivers Avaialable-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection No Drivers Avaialable-Get Health Trips

6. Get Health Trip By Trip ID

Scenarios-Run Collection On Demand-Authorization

1. Generate Access Token

Scenarios-Run Collection On Demand-Create and Get Run

2. Create Run 3. Get Run

Scenarios-Run Collection On Demand-Trip Estimates

4a. Get Health Trip Estimates - On Demand

Scenarios-Run Collection On Demand-Create Health Trip

5a. Create Health Trip - On Demand

Scenarios-Run Collection On Demand-Change Driver State

6. Change Driver State - DROPOFF

Scenarios-Run Collection On Demand-Get Health Trips

7. Get Health Trip By Trip ID

Vouchers API - Production

Generate Access Token (client_credentials)

Voucher program creation: Without Template

Create Voucher Program

Voucher program creation: With Template

Create Voucher Template Create Voucher Program From Template

Voucher Program Managment

Cancel Voucher Program Search Voucher Programs Update Voucher Program Get Voucher Program

Voucher Code Managment

Get Voucher Codes Generate Voucher Codes Cancel Voucher Codes

Voucher Redemption and Comms

Add Guest Bulk Distribution of Voucher Redemption Codes Redeem Voucher Code

Vouchers API - Sandbox

Generate Access Token (client_credentials)

Voucher program creation: Without Template

Create Voucher Program

Voucher program creation: With Template

Create Voucher Program From Template Create Voucher Template

Voucher Program Managment

Get Voucher Program Cancel Voucher Program Search Voucher Programs Update Voucher Program

Voucher Code Managment

Generate Voucher Codes Get Voucher Codes Cancel Voucher Codes

Voucher Redemption and Comms

Redeem Voucher Code Bulk Distribution of Voucher Redemption Codes Add Guest

Create Run GET Run

Home Vouchers API - SandboxRun

Run

Number of APIs: 2

Create Run POST {{sandbox_base_url}}/sandbox/terminal-state-trip-run
GET Run GET {{sandbox_base_url}}/sandbox/run/:run_id