# Get routes

Get list of routes

Endpoint: GET /routes/{offset}/{amount}
Version: 0.9.74
Security: bearer, apiKey, apiSecret

## Header parameters:

  - `Authorization` (string, required)

## Path parameters:

  - `offset` (integer, required)

  - `amount` (integer, required)

## Response 200 fields (application/json):

  - `success` (boolean)

  - `message` (string)

  - `code` (integer)

  - `totalResults` (integer)

  - `routes` (array)

  - `routes.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.uuid` (string, required)

  - `routes.primaryPlatformId` (string, required)

  - `routes.createdAt` (string)
    The date and time this Entity has been created

  - `routes.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.language` (object)
    circular reference

  - `routes.name` (string)

  - `routes.time` (integer)

  - `routes.cost` (integer)

  - `routes.distance` (integer)

  - `routes.expenses` (array)

  - `routes.expenses.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.expenses.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.expenses.createdAt` (string)
    The date and time this Entity has been created

  - `routes.expenses.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.expenses.sequenceNr` (integer)

  - `routes.expenses.quantity` (integer)

  - `routes.expenses.name` (string)

  - `routes.expenses.description` (string)

  - `routes.expenses.category` (object)

  - `routes.expenses.category.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.expenses.category.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.expenses.category.createdAt` (string)
    The date and time this Entity has been created

  - `routes.expenses.category.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.expenses.category.name` (string)

  - `routes.expenses.category.creditCode` (string)

  - `routes.expenses.category.debitCode` (string)

  - `routes.expenses.category.defaultValue` (number)

  - `routes.expenses.category.enabled` (boolean)

  - `routes.expenses.category.tripRevenue` (boolean)

  - `routes.expenses.category.identifiers` (array)

  - `routes.expenses.category.identifiers.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.expenses.category.identifiers.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.expenses.category.identifiers.createdAt` (string)
    The date and time this Entity has been created

  - `routes.expenses.category.identifiers.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.expenses.category.identifiers.name` (string)

  - `routes.expenses.category.identifiers.system` (string)

  - `routes.expenses.category.identifiers.value` (string)

  - `routes.expenses.category.identifiers.expiredAt` (string)

  - `routes.expenses.business` (object)
    circular reference

  - `routes.expenses.amount` (object)

  - `routes.expenses.amount.amount` (number)

  - `routes.expenses.amount.currency` (object)

  - `routes.expenses.amount.currency.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.expenses.amount.currency.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.expenses.amount.currency.createdAt` (string)
    The date and time this Entity has been created

  - `routes.expenses.amount.currency.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.expenses.amount.currency.name` (string)

  - `routes.expenses.amount.currency.short` (string)

  - `routes.expenses.amount.currency.sign` (string)

  - `routes.expenses.amount.currency.decimalDelimiter` (string)

  - `routes.expenses.amount.currency.thousandDelimiter` (string)

  - `routes.expenses.amount.currency.enabled` (boolean)

  - `routes.expenses.amount.taxRate` (object)

  - `routes.expenses.amount.taxRate.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.expenses.amount.taxRate.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.expenses.amount.taxRate.createdAt` (string)
    The date and time this Entity has been created

  - `routes.expenses.amount.taxRate.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.expenses.amount.taxRate.creditCode` (string)

  - `routes.expenses.amount.taxRate.debitCode` (string)

  - `routes.expenses.amount.taxRate.identifiers` (array)

  - `routes.expenses.amount.taxRate.name` (string)

  - `routes.expenses.amount.taxRate.description` (string)

  - `routes.expenses.amount.taxRate.jurisdiction` (string)

  - `routes.expenses.amount.taxRate.percentage` (number)

  - `routes.expenses.amount.taxRate.inclusive` (boolean)

  - `routes.expenses.amount.taxRate.active` (boolean)

  - `routes.expenses.amount.inclusiveOfTax` (boolean)

  - `routes.expenses.subTotal` (object)

  - `routes.expenses.tax` (object)

  - `routes.expenses.total` (object)

  - `routes.additionalInfo` (object)

  - `routes.lineString` (string)

  - `routes.actors` (array)

  - `routes.actors.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.actors.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.actors.uuid` (string, required)

  - `routes.actors.primaryPlatformId` (string, required)

  - `routes.actors.createdAt` (string)
    The date and time this Entity has been created

  - `routes.actors.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.actors.language` (object)
    circular reference

  - `routes.actors.name` (string)

  - `routes.actors.user` (object)
    circular reference

  - `routes.actors.identifiers` (array)

  - `routes.actors.identifiers.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.actors.identifiers.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.actors.identifiers.uuid` (string, required)

  - `routes.actors.identifiers.primaryPlatformId` (string, required)

  - `routes.actors.identifiers.createdAt` (string)
    The date and time this Entity has been created

  - `routes.actors.identifiers.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.actors.identifiers.language` (object)
    circular reference

  - `routes.actors.identifiers.name` (string)

  - `routes.actors.identifiers.system` (string)

  - `routes.actors.identifiers.value` (string)

  - `routes.actors.identifiers.expiredAt` (string)

  - `routes.actors.contactDetails` (array)

  - `routes.actors.contactDetails.id` (string, required)
    Uniquely identifies this entity. A ID can be assigned  or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed

  - `routes.actors.contactDetails.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `routes.actors.contactDetails.uuid` (string, required)

  - `routes.actors.contactDetails.primaryPlatformId` (string, required)

  - `routes.actors.contactDetails.createdAt` (string)
    The date and time this Entity has been created

  - `routes.actors.contactDetails.updatedAt` (string)
    The date and time this Entity has been updated

  - `routes.actors.contactDetails.language` (object)
    circular reference

  - `routes.actors.contactDetails.type` (string)
    Enum: "iban", "gln", "vatCode", "name", "lastName", "middleName", "firstName", "phone", "mobilePhone", "email", "language", "other"

  - `routes.actors.contactDetails.value` (string)

  - `routes.actors.contactDetails.remarks` (string)

  - `routes.actions` (array)

  - `routes.constraints` (array)

  - `routes.constraints.associationType` (string, required)

  - `routes.identifiers` (array)

## Response 400 fields (application/json):

  - `success` (boolean)

  - `message` (string)

  - `code` (integer)

  - `errors` (array)

  - `suggestion` (string)