Query Vehicles

GET

/

Query vehicles

Resource Details

Security

Category

Vehicles

Request

Path Parameters

Parameter Type Description Required

Query Parameters

Parameter Type Description Required
vin string Filters the queryby vehicle VIN No
licenseId string Filters the query by vehicle license identifier No
customerLink string Filters the query bythe hypermedia link to the owner record No
page number A non-zero integer representing the page of the results No
pageSize number A non-negative, non-zero integer indicating the maximum number of results to return at one time No

Header Parameters

Parameter Type Description Required
Accept string n/a No
Accept-Charset string n/a No
Accept-Language string n/a No
Prefer string n/a No
Request-Id string n/a No
Subscription-Id string The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'. Yes
Authorization string Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret. Yes

Request Body Structure

Expand All
Collapse All

Request Body Example

Response

Response Body Structure

Expand All
Collapse All

Response Body Example

Response Error Details

HTTP Code Description
400 400 - Bad Request
401 401 - Unauthorized
403 403 - Forbidden
404 404 -Not Found

Try It Out

  • vin

    (string) Filters the queryby vehicle VIN

  • licenseId

    (string) Filters the query by vehicle license identifier

  • customerLink

    (string) Filters the query bythe hypermedia link to the owner record

  • page

    (number) A non-zero integer representing the page of the results

  • pageSize

    (number) A non-negative, non-zero integer indicating the maximum number of results to return at one time

  • Accept

    (string)

  • Accept-Charset

    (string)

  • Accept-Language

    (string)

  • Prefer

    (string)

  • Request-Id

    (string)

  • Subscription-Id
    (required)

    (string) The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'.

  • Authorization
    (required)

    (string) Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret.

Reset

Make a request and see the request.

Make a request and see the response.

Make a request and see the cURL.

Working...

x