BIbigchange
Routes

Get a list of routes

Changed on

Retrieves a paged collection of routes belonging to the authenticated customer (required scope routes:read)

get/v1/routes

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/routes
  • Auth
    HTTP bearer

Query parameters

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 5514123,
      "name": "South East Round",
      "stopCount": 8,
      "stopDurationMinutes": 120,
      "distanceKm": 42.5,
      "durationMinutes": 65
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes