Service providers

Get service providers' current locations

get

Fetches current locations for multiple service providers prioritizing live locations with fallback to addresses

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

serviceProviderIdsstring[]Required

List of service provider IDs

Default: []Example: ["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"]

latLongMaxAgeHoursnumberOptional

Maximum age of the lat/long coordinates in hours

Default: 24Example: 24

includeLatestStatusbooleanOptional

Indicates if latest status of the service provider location has to be included

Example: true

startDateTimeone ofOptional

Indicates the start date for filtering service provider locations

Example: 2023-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

endDateTimeone ofOptional

Indicates the end date for filtering service provider locations

Example: 2023-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

classanyRequired

Responses

200Success

application/json

get

/api/location/service-providers

HTTPcURLJavaScriptPython

GET /api/location/service-providers?serviceProviderIds=123e4567-e89b-12d3-a456-426614174000&class=null HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "externalId": "12345",
    "serviceProviderLocation": {
      "address": "123 Main St, New York, NY",
      "addressId": 1,
      "latitude": 40.7128,
      "longitude": -74.006,
      "routes": {
        "distanceMeters": 1000,
        "duration": 10,
        "polyline": {
          "points": "encodedPolyline"
        }
      }
    },
    "patientLocation": {
      "address": "123 Main St, New York, NY",
      "addressId": 1,
      "latitude": 40.7128,
      "longitude": -74.006,
      "routes": {
        "distanceMeters": 1000,
        "duration": 10,
        "polyline": {
          "points": "encodedPolyline"
        }
      }
    },
    "origin": {
      "address": "123 Main St, New York, NY",
      "addressId": 1,
      "latitude": 40.7128,
      "longitude": -74.006,
      "routes": {
        "distanceMeters": 1000,
        "duration": 10,
        "polyline": {
          "points": "encodedPolyline"
        }
      }
    },
    "destinations": {
      "address": "123 Main St, New York, NY",
      "addressId": 1,
      "latitude": 40.7128,
      "longitude": -74.006,
      "routes": {
        "distanceMeters": 1000,
        "duration": 10,
        "polyline": {
          "points": "encodedPolyline"
        }
      }
    },
    "routes": []
  }
]