Recommendations

Generate optimal routes

get

Generates optimal routes for field staff appointments based on location and availability

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

organizationIdnumberRequired

Organization ID

Example: 1

carePlanIdintegerOptional

Organization ID

Example: 1

dateone ofRequired

Date for which to generate routes

Example: 2025-01-03

string · dateOptional

or

string · date-timeOptional

algorithmnumberRequired

Routing algorithm Id to use

Example: 1

startDateTimeone ofRequired

Start date time for the route

Example: 2025-01-03T08:00:00

string · dateOptional

or

string · date-timeOptional

endDateTimeone ofRequired

End date time for the route

Example: 2025-01-03T17:00:00

string · dateOptional

or

string · date-timeOptional

serviceProviderIdstringOptional

Service Provider Id

Example: 123456789

generatePolylinebooleanOptional

Flag to indicate if polyline generation is required

Example: true

Responses

200Success

application/json

400

Invalid input parameters

get

/api/routing/recommendations

HTTPcURLJavaScriptPython

GET /api/routing/recommendations?organizationId=1&date=2025-01-03&algorithm=1&startDateTime=2025-01-03T08%3A00%3A00&endDateTime=2025-01-03T17%3A00%3A00 HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": null,
  "error": "text"
}