Skip to main content

Retrieve a list of vehicles for a user (by phone)

GET 
/api/users/by-phone/:phoneNumber/vehicles

Retrieve a list of vehicles for a user. The user is identified by the cell phone number of the user and in the format +1CCCBBBAAAA. If the caller does not have access to the user throws an exception.

Request​

Path Parameters

    phoneNumber stringrequired

Header Parameters

    partnerId stringrequired

    Partner Id

    clientId stringrequired

    Client Id

    clientSecret stringrequired

    Client Secret

Responses​

List of vehicles owned by user.

Schema

  • Array [

    • id string

    Id of the vehicle

    license string

    License plate number

    photoUrl string

    Photo of Vehicle

    make string

    Make of the vehicle

    model string

    Model of the vehicle

    vin string

    VIN of the vehicle.

    state string

    2 Letter State Code (eg. AL, CA, CO etc.)

    year string

    Year vehicle was built.

    dateAdded string

    Time at which vehicle was added to the system

    updated string

    Last updated timestamp

    userId string

    User id of the owner

    customerPhoneNumber string

    Phone number of the owner

    active boolean

  • ]

Loading...