Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Disposition|Tour

Fetch tour list.

This endpoint enables you to access a list of tours. You may add various filter options to ensure that you obtain the desired data. The response will provide you with fundamental details about the tour, including a team reference, the number of orders, and the number of stops.

A tour comprises various stops determined by the addresses of assigned orders. Through an optimization function, stops are sequenced for optimal efficiency, considering distances and travel times. Stops can be manually sequenced and calculated or optimized. Tour costs are automatically computed, including any user-adjusted arrival and departure times, which may result in calculated waiting times for the team. These waiting times are also factored into the cost calculation.

If you require more detailed information, such as the list of the stops, please make use of the /tour/fetch_data endpoint.

get/tour/fetch

Query parameters

filter[byIds][]integer[]

Filters the tour based on the internal IDs.

filter[byDistrict][]integer[]

Filters the tour based on the area.

filter[byTeam][]integer[]

Filters the tour based on the team.

filter[byStatus]string

Filters the tour based on its status.

filter[from]string
Example:2022-12-22

Filters the tour based on the given date.

filter[to]string
Example:2022-12-22

Filters the tour based on the given date.

offsetinteger

Use this parameter to specify the number of records you want to skip before starting to collect the data from the result set. This paramter is optional.

limitinteger

The limit parameter defines the maximum number of records that can be retrieved in a single API request, with a max and default value set at 500 records.

Response

Success Response:

offsetinteger

Number of skipped records.

totalCountinteger

Total number of available tours. (Only calculated if offset is 0)

Example response

{
  "data": [
    {
      "startDate": "2015-02-20"
    }
  ]
}