GET
/
vehicles
curl --request GET \
  --url https://commerce.driv.ly/api/vehicles \
  --header 'Authorization: <api-key>'
{
  "docs": [
    {
      "name": "<string>",
      "vin": "<string>",
      "customer": 123,
      "status": [
        "Bought at Auction"
      ],
      "deals": [
        123
      ],
      "year": "<string>",
      "make": "<string>",
      "model": "<string>",
      "trim": "<string>",
      "style": "<string>",
      "body": "<string>",
      "drivetrain": "<string>",
      "engine": "<string>",
      "transmission": "<string>",
      "interior": "<string>",
      "exterior": "<string>",
      "listings": [
        123
      ],
      "serviceQuotes": [
        123
      ],
      "tenant": 123,
      "trades": [
        123
      ],
      "createdBy": 123,
      "transportServiceOrders": "<string>",
      "transportServiceOrders2": [
        123
      ],
      "updatedAt": "<string>",
      "createdAt": "<string>"
    }
  ],
  "totalDocs": 123,
  "limit": 123,
  "totalPages": 123,
  "page": 123,
  "pagingCounter": 123,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 123,
  "nextPage": 123
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

​
sort
string

sort by field

​
where
object

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

Response

200 - application/json

ok

The response is of type object.