Find paginated Customers
curl --request GET \
--url https://commerce.driv.ly/api/customers \
--header 'Authorization: <api-key>'import requests
url = "https://commerce.driv.ly/api/customers"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://commerce.driv.ly/api/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://commerce.driv.ly/api/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://commerce.driv.ly/api/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://commerce.driv.ly/api/customers")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"docs": [
{
"updatedAt": "<string>",
"createdAt": "<string>",
"customerId": "<string>",
"leads": [
123
],
"address": 123,
"shippingContact": 123,
"deals": [
123
],
"createdBy": 123,
"lastModifiedBy": 123,
"email": "<string>",
"phone": "<string>",
"insurancePolicies": [
123
],
"tenants": [
123
],
"consumerFirstName": "<string>",
"consumerMiddleName": "<string>",
"consumerLastName": "<string>",
"consumerSuffix": "<string>",
"consumerDateOfBirth": "<string>",
"consumerEducationLevel": "<string>",
"consumerVehicles": [
123
],
"consumerPhoneType": "<string>",
"consumerDriversLicense": "<string>",
"consumerDriversLicenseState": "<string>",
"consumerDriversLicenseNumber": "<string>",
"consumerDriversLicenseExp": "<string>",
"consumerDriversLicenseExpiration": "<string>",
"consumerPreApprovals": [
123
],
"consumerGetPreApproved": "<string>",
"consumerProvideProofOfInsurance": "<string>",
"consumerLoginToBank": "<string>",
"consumerConnectCar": "<string>",
"consumerProvideProofOfIncome": "<string>",
"consumerConsumerId": "<string>",
"consumerCreditApplicationId": "<string>",
"deals2": [
123
],
"consumerSocialSecurity": "<string>",
"consumerDriversLicenceState": "<string>",
"consumerIncome": 123,
"consumerIncomeInterval": "<string>",
"consumerEmploymentStatusCode": "<string>",
"consumerEmploymentDuration": 123,
"consumerEmployerName": "<string>",
"consumerEmployerPhone": "<string>",
"consumerEmploymentTitle": "<string>",
"consumerPreviousEmployerName": "<string>",
"consumerPreviousEmployerPhone": "<string>",
"consumerPreviousEmploymentTitle": "<string>",
"consumerPreviousEmploymentDuration": 123,
"consumerPreviousEmploymentincome": 123,
"consumerTimeAtResidence": 123,
"consumerPreviousAddressLine1": "<string>",
"consumerPreviousAddressLine2": "<string>",
"consumerPreviousAddressCity": "<string>",
"consumerPreviousAddressState": "<string>",
"consumerPreviousZip": "<string>",
"consumerPreviousAddressDuration": 123,
"consumerResidenceType": "<string>",
"consumerRentMortgage": 123,
"consumerOtherIncomeDescription": "<string>",
"consumerOtherIncomeAmount": 123,
"consumerLeadSource": [],
"companyName": "<string>",
"companyDealerDeals": [
123
],
"companyDealsFacilitated": [
123
],
"companyInsuranceQuotes": [
123
],
"companyType": [],
"companyWebsite": "<string>",
"companyStripeConnectLink": "<string>",
"companyCustomerPortalLink": "<string>",
"companyServiceQuotes": [
123
],
"companyServiceOrders": "<string>",
"companyServiceQuotesPartners": [
123
],
"companyVisibility": "<string>",
"companyTenants2": [
123
],
"companyCustomer": [
123
],
"companyTrades": [
123
],
"companyTenants3": [
123
],
"companyPartnerBrand": 123,
"companyDeals3": [
123
],
"companyRouteOneDealer": "<string>",
"companyTransportServiceOrders": [
123
]
}
],
"totalDocs": 123,
"limit": 123,
"totalPages": 123,
"page": 123,
"pagingCounter": 123,
"hasPrevPage": true,
"hasNextPage": true,
"prevPage": 123,
"nextPage": 123
}Customers
Find paginated Customers
Find paginated Customers
GET
/
customers
Find paginated Customers
curl --request GET \
--url https://commerce.driv.ly/api/customers \
--header 'Authorization: <api-key>'import requests
url = "https://commerce.driv.ly/api/customers"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://commerce.driv.ly/api/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://commerce.driv.ly/api/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://commerce.driv.ly/api/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://commerce.driv.ly/api/customers")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"docs": [
{
"updatedAt": "<string>",
"createdAt": "<string>",
"customerId": "<string>",
"leads": [
123
],
"address": 123,
"shippingContact": 123,
"deals": [
123
],
"createdBy": 123,
"lastModifiedBy": 123,
"email": "<string>",
"phone": "<string>",
"insurancePolicies": [
123
],
"tenants": [
123
],
"consumerFirstName": "<string>",
"consumerMiddleName": "<string>",
"consumerLastName": "<string>",
"consumerSuffix": "<string>",
"consumerDateOfBirth": "<string>",
"consumerEducationLevel": "<string>",
"consumerVehicles": [
123
],
"consumerPhoneType": "<string>",
"consumerDriversLicense": "<string>",
"consumerDriversLicenseState": "<string>",
"consumerDriversLicenseNumber": "<string>",
"consumerDriversLicenseExp": "<string>",
"consumerDriversLicenseExpiration": "<string>",
"consumerPreApprovals": [
123
],
"consumerGetPreApproved": "<string>",
"consumerProvideProofOfInsurance": "<string>",
"consumerLoginToBank": "<string>",
"consumerConnectCar": "<string>",
"consumerProvideProofOfIncome": "<string>",
"consumerConsumerId": "<string>",
"consumerCreditApplicationId": "<string>",
"deals2": [
123
],
"consumerSocialSecurity": "<string>",
"consumerDriversLicenceState": "<string>",
"consumerIncome": 123,
"consumerIncomeInterval": "<string>",
"consumerEmploymentStatusCode": "<string>",
"consumerEmploymentDuration": 123,
"consumerEmployerName": "<string>",
"consumerEmployerPhone": "<string>",
"consumerEmploymentTitle": "<string>",
"consumerPreviousEmployerName": "<string>",
"consumerPreviousEmployerPhone": "<string>",
"consumerPreviousEmploymentTitle": "<string>",
"consumerPreviousEmploymentDuration": 123,
"consumerPreviousEmploymentincome": 123,
"consumerTimeAtResidence": 123,
"consumerPreviousAddressLine1": "<string>",
"consumerPreviousAddressLine2": "<string>",
"consumerPreviousAddressCity": "<string>",
"consumerPreviousAddressState": "<string>",
"consumerPreviousZip": "<string>",
"consumerPreviousAddressDuration": 123,
"consumerResidenceType": "<string>",
"consumerRentMortgage": 123,
"consumerOtherIncomeDescription": "<string>",
"consumerOtherIncomeAmount": 123,
"consumerLeadSource": [],
"companyName": "<string>",
"companyDealerDeals": [
123
],
"companyDealsFacilitated": [
123
],
"companyInsuranceQuotes": [
123
],
"companyType": [],
"companyWebsite": "<string>",
"companyStripeConnectLink": "<string>",
"companyCustomerPortalLink": "<string>",
"companyServiceQuotes": [
123
],
"companyServiceOrders": "<string>",
"companyServiceQuotesPartners": [
123
],
"companyVisibility": "<string>",
"companyTenants2": [
123
],
"companyCustomer": [
123
],
"companyTrades": [
123
],
"companyTenants3": [
123
],
"companyPartnerBrand": 123,
"companyDeals3": [
123
],
"companyRouteOneDealer": "<string>",
"companyTransportServiceOrders": [
123
]
}
],
"totalDocs": 123,
"limit": 123,
"totalPages": 123,
"page": 123,
"pagingCounter": 123,
"hasPrevPage": true,
"hasNextPage": true,
"prevPage": 123,
"nextPage": 123
}Usage with the Drivly SDK
Usage with the Drivly SDK
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { customers } from '@drivly/commerce'
const sdk = new SDK(...)
const customers = await sdk.customers.find(): Promise<customers[]>
Authorizations
Query Parameters
number of levels to automatically populate relationships and uploads
retrieves document(s) in a specific locale
specifies a fallback locale if no locale value exists
sort by field
pass a where query to constrain returned documents (complex type, see documentation)
Show child attributes
Show child attributes
Example:
{
"or": [
{ "color": { "equals": "mint" } },
{
"and": [
{ "color": { "equals": "white" } },
{ "featured": { "equals": false } }
]
}
]
}
limit the returned documents to a certain number
get a specific page of documents
⌘I