GET
/
vdpEmails
/
{id}
curl --request GET \
  --url https://commerce.driv.ly/api/vdpEmails/{id} \
  --header 'Authorization: <api-key>'
{
  "status": "Draft",
  "lead": 123,
  "vins": [
    123
  ],
  "createdBy": 123,
  "lastModifiedBy": 123,
  "vinCount": "<string>",
  "updatedAt": "<string>",
  "createdAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Vdp Email

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
​
updatedAt
string
required
​
createdAt
string
required
​
status
enum<string> | null
Available options:
Draft,
Send,
Sent
​
lead
​
vins
array | null
​
createdBy
number
​
lastModifiedBy
number
​
vinCount
string | null