Skip to main content
GET
/
searches
/
{id}
Get a single Search by its id
curl --request GET \
  --url https://commerce.driv.ly/api/searches/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "lead": 123,
  "status": "On Hold",
  "retailListingUrls": "<string>",
  "year": "<string>",
  "make": "<string>",
  "model": "<string>",
  "trim": "<string>",
  "bodyStyle": [
    "car"
  ],
  "drive": [
    "4WD"
  ],
  "transmission": [
    "Manual"
  ],
  "maxPrice": "<string>",
  "maxMiles": 123,
  "newOrUsed": [
    "New"
  ],
  "minimumGrade": 123,
  "requiredOptions": [
    "Heated Seats"
  ],
  "acceptableColors": [
    "Anti-Black"
  ],
  "acceptableInterior": [
    "Beige"
  ],
  "proposedVehicles": "<string>",
  "vehicles": [
    123
  ],
  "lastModifiedBy": 123,
  "seats": "<string>",
  "updateRequested": "<string>",
  "oneOwner": true,
  "priority": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.drivly.dev/llms.txt

Use this file to discover all available pages before exploring further.

Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { searches } from '@drivly/commerce'

const sdk = new SDK(...)

const searches = await sdk.searches.findOne(searchesId: string): Promise<searches>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Search

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
Where clause · 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

ok

​
updatedAt
string
required
​
createdAt
string
required
​
lead
​
status
enum<string> | null
Available options:
On Hold,
Searching,
Results Found,
Search Cancelled
​
retailListingUrls
string | null
​
year
string | null
​
make
string | null
​
model
string | null
​
trim
string | null
​
bodyStyle
enum<string>[] | null
Available options:
car,
suv,
truck,
van,
wagon
​
drive
enum<string>[] | null
Available options:
4WD,
AWD,
2WD
​
transmission
enum<string>[] | null
Available options:
Manual,
Automatic
​
maxPrice
string | null
​
maxMiles
number | null
​
newOrUsed
enum<string>[] | null
Available options:
New,
Certified,
Used
​
minimumGrade
number | null
​
requiredOptions
enum<string>[] | null
Available options:
Heated Seats,
No crazy colors,
Tow package,
Heated wheel,
Panoramic sunroof,
Leather Seats,
Bluetooth,
Backup Camera,
Apple Play,
Cooled Seats
​
acceptableColors
enum<string>[] | null
Available options:
Anti-Black,
Anti-Gray,
Anti-Red,
Anti-Silver,
Anti-White,
Beige,
Black,
Blue,
Brown,
Gold,
Gray,
Green,
Light Blue,
Orange,
Red,
Silver,
White,
Yellow
​
acceptableInterior
enum<string>[] | null
Available options:
Beige,
Black,
Brown,
Cream,
Gray,
Ivory,
Red,
Tan,
White,
Blue,
Burgundy,
Charcoal,
Off-White
​
proposedVehicles
string | null
​
vehicles
(number | Vehicle · object)[] | null
​
lastModifiedBy
number
​
seats
string | null
​
updateRequested
string | null
​
oneOwner
boolean | null
​
priority
boolean | null