Skip to main content

List User Vehicles

GET 
/vehicles

Lists all vehicles for a user.

If a user has a valid payment method, these vehicles will be used for automated entry into parkings that support this facility.

The response header `x-total-records` will return the total number of vehicles for this user, this might be useful when paginating over a lot of results.

Request​

Query Parameters

    limit integer

    Default value: 100

    Number of records to return (defaults to 100, max 1000)

    Example: 100
    offset integer

    Number of records to skip/offset (for pagination, defaults to 0)

    Example: 0

Header Parameters

    x-access-token string

    Authentication header obtained from POST /authenticate that identifies the user making this call.

    Example: NgDvLMpPq.6AgfCvkP.YEWA3ZX
    x-api-user string

    Authentication header obtained from POST /authenticate that identifies the client making this call.

    Example: AbC123DeF456GhI789JkL012
    x-api-key string

    Authentication header obtained from POST /authenticate that identifies the user making this call.

    Example: XyZ456AbC789DeF012GhI345

Responses​

OK

Response Headers
  • x-total-records integer

    Total number of vehicles for this user

Schema
  • Array [
    • plate stringrequired

    Number plate for the vehicle. Uppercase, without spaces (ie 0388VCP)

    brand stringrequired

    The brand of the vehicle (ie Seat)

    model stringrequired

    The model of the vehicle (ie Ibiza)

    tag string

    Possible values: [0, C, B, ECO]

    The environmental tag for the vehicle (ie C)

    listProviders string[]

    Default value: ``

    List of suppliers with automatic access to register the vehicle. Those that were previously on the list and are not sent will be cancelled.

  • ]
Loading...