Skip to main content
GET
/
crmTrades
/
{id}
Get a single Crm Trade by its id
curl --request GET \
  --url https://commerce.driv.ly/api/crmTrades/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "vin": "<string>",
  "lead": 123,
  "year": "<string>",
  "make": "<string>",
  "model": "<string>",
  "trim": "<string>",
  "photos": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { crmTrades } from '@drivly/commerce'

const sdk = new SDK(...)

const crmTrades = await sdk.crmTrades.findOne(crmTradesId: string): Promise<crmTrades>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Crm Trade

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
​
vin
string | null
​
lead
​
year
string | null
​
make
string | null
​
model
string | null
​
trim
string | null
​
photos
string | null