Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Drivly Docs","colors":{"primary":"#00CAB9","light":"#A8F6F6","dark":"#03C2B2"},"favicon":"favicon.svg","logo":{"light":"https://mintcdn.com/drivly/lS-LOhC8keZU5zBZ/logo/light.svg?fit=max\u0026auto=format\u0026n=lS-LOhC8keZU5zBZ\u0026q=85\u0026s=2949247e5550eeee3c33c8516df55d81","dark":"https://mintcdn.com/drivly/lS-LOhC8keZU5zBZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=lS-LOhC8keZU5zBZ\u0026q=85\u0026s=f76b40c1a0f68056c33562b70022bce6"},"background":{"decoration":null,"color":{"light":null,"dark":"#121212"}},"navbar":{"links":[{"label":"Contact","href":"mailto:sales@driv.ly"}],"primary":{"type":"button","label":"Join waitlist","href":"https://drivly.ai/contact"}},"footer":{"socials":{"twitter":"https://twitter.com/drivly","github":"https://github.com/drivly","linkedin":"https://www.linkedin.com/company/drivly"}},"integrations":{"ga4":{"measurementId":"G-T45DEGR8GE"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"drivly","hasAudioNarration":false,"actualSubdomain":"drivly","customDomains":["docs.driv.ly"],"gitSource":{"type":"github","owner":"drivly","repo":"docs.driv.ly","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e607b8c65e77d66776a6","collectionId":"e946aa0a-f5cd-4ff9-910f-45b21375f2b6","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e607b8c65e77d66776a6:success","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Documentation","count":290},{"language":"default","tag":"API Reference","count":188},{"language":"default","tag":"Services","count":166},{"language":"default","tag":"Data","count":92},{"language":"default","tag":"Commerce","count":52},{"language":"default","tag":"AI","count":43},{"language":"default","tag":"Entities","count":32},{"language":"default","tag":"Companies","count":26},{"language":"default","tag":"Vehicle","count":21},{"language":"default","tag":"Listings","count":20}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"snippets/snippets.css","content":":root{--story-board-background:#f9f8fc;--story-board-border:#e2e2e7;--hero-background:#fbfbfc}.dark{--story-board-background:#1a1a1a;--story-board-border:#333;--hero-background:#1a1a1a}.storyBoard{padding:32px 24px;background-color:var(--story-board-background);font-size:16px;line-height:36px;border-radius:4px}.heroContent{background-color:var(--hero-background)}"}],"page":{"pagePath":"commerce/endpoints/deals/get-customers","slug":"/commerce/endpoints/deals/get-customers","pageMetadata":{"openapi":"Commerce get /customers","title":"Get Customers","description":null,"href":"/commerce/endpoints/deals/get-customers"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"Commerce get /customers","title":"Get Customers","description":null,"href":"/commerce/endpoints/deals/get-customers"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/drivly/e3b0c44298fc1c14/augment-docs.js","/_mintlify/custom/drivly/13b28860dab2dbb1/generate-examples.js","/_mintlify/custom/drivly/51178f86c52b51b0/commerce/needWork.js","/_mintlify/custom/drivly/2c75ac436d1b00e4/services/finance-and-insurance/pre-approval/otherApi.js","/_mintlify/custom/drivly/c218e26da81e9d98/commerce/ohNotWorking.js","/_mintlify/custom/drivly/20977b91dae647eb/ai/validate.js"],"openApiReferenceData":{"operation":{"summary":"Get Customers","operationId":"get-customers-list","responses":{"200":"db354e55-03f4-4bd7-888b-baa422d5d703","401":"2378ff6e-8483-476b-bed5-0b6cb047c71b","429":"434b5008-476d-46dd-8a29-c7358302a63b"},"parameters":["646463e2-c2c1-4469-9dfa-fea32f18a36a","e2f31bd0-090e-417d-8f25-66e8bc0eb147","ef31c765-8855-4317-adde-326f69481dd1"],"method":"get","type":"path","servers":["97d902c7-7c79-48c5-91b0-8ede0ad052a3"],"security":[],"path":"/customers","baseUrlOptions":["https://commerce.driv.ly/api"],"title":"Get Customers","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"646463e2-c2c1-4469-9dfa-fea32f18a36a":{"schema":{"type":"string","description":"Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol (\"-\") to sort in descending order.","uniqueKey":"","typeLabel":"string"},"in":"query","name":"sort","description":"Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol (\"-\") to sort in descending order."},"e2f31bd0-090e-417d-8f25-66e8bc0eb147":{"schema":{"type":"number","description":"Limit number of results, default 10","uniqueKey":"","typeLabel":"number"},"in":"query","name":"limit","description":"Limit number of results, default 10"},"ef31c765-8855-4317-adde-326f69481dd1":{"schema":{"type":"object","properties":{"and":{"type":"array","items":{"$circularRef":"4517e773-4abf-45ac-980a-fbda4ce1c568"},"uniqueKey":"and","typeLabel":"array"},"or":{"type":"array","items":{"$circularRef":"4517e773-4abf-45ac-980a-fbda4ce1c568"},"uniqueKey":"or","typeLabel":"array"},"id":{"type":"object","properties":{"equals":{"type":"string","description":"The value must be exactly equal.","uniqueKey":"id.equals","typeLabel":"string"},"not_equals":{"type":"string","description":"The query will return all documents where the value is not equal.","uniqueKey":"id.not_equals","typeLabel":"string"},"like":{"type":"string","description":"Case-insensitive string must be present. If string of words, all words must be present, in any order.","uniqueKey":"id.like","typeLabel":"string"},"contains":{"type":"string","description":"Must contain the value entered, case-insensitive.","uniqueKey":"id.contains","typeLabel":"string"},"in":{"type":"string","description":"The value must be found within the provided comma-delimited list of values.","uniqueKey":"id.in","typeLabel":"string"},"not_in":{"type":"string","description":"The value must NOT be within the provided comma-delimited list of values.","uniqueKey":"id.not_in","typeLabel":"string"},"all":{"type":"string","description":"The value must contain all values provided in the comma-delimited list.","uniqueKey":"id.all","typeLabel":"string"},"exists":{"type":"boolean","description":"Only return documents where the value either exists (true) or does not exist (false).","uniqueKey":"id.exists","typeLabel":"boolean"}},"uniqueKey":"id","typeLabel":"object"},"addresses":{"type":"object","properties":{"equals":{"type":"array","description":"The value must be exactly equal.","uniqueKey":"addresses.equals","typeLabel":"array"},"not_equals":{"type":"array","description":"The query will return all documents where the value is not equal.","uniqueKey":"addresses.not_equals","typeLabel":"array"},"like":{"type":"string","description":"Case-insensitive string must be present. If string of words, all words must be present, in any order.","uniqueKey":"addresses.like","typeLabel":"string"},"contains":{"type":"string","description":"Must contain the value entered, case-insensitive.","uniqueKey":"addresses.contains","typeLabel":"string"},"in":{"type":"string","description":"The value must be found within the provided comma-delimited list of values.","uniqueKey":"addresses.in","typeLabel":"string"},"not_in":{"type":"string","description":"The value must NOT be within the provided comma-delimited list of values.","uniqueKey":"addresses.not_in","typeLabel":"string"},"all":{"type":"string","description":"The value must contain all values provided in the comma-delimited list.","uniqueKey":"addresses.all","typeLabel":"string"},"exists":{"type":"boolean","description":"Only return documents where the value either exists (true) or does not exist (false).","uniqueKey":"addresses.exists","typeLabel":"boolean"}},"uniqueKey":"addresses","typeLabel":"object"},"phoneNumbers":{"type":"object","properties":{"equals":{"type":"array","description":"The value must be exactly equal.","uniqueKey":"phoneNumbers.equals","typeLabel":"array"},"not_equals":{"type":"array","description":"The query will return all documents where the value is not equal.","uniqueKey":"phoneNumbers.not_equals","typeLabel":"array"},"like":{"type":"string","description":"Case-insensitive string must be present. If string of words, all words must be present, in any order.","uniqueKey":"phoneNumbers.like","typeLabel":"string"},"contains":{"type":"string","description":"Must contain the value entered, case-insensitive.","uniqueKey":"phoneNumbers.contains","typeLabel":"string"},"in":{"type":"string","description":"The value must be found within the provided comma-delimited list of values.","uniqueKey":"phoneNumbers.in","typeLabel":"string"},"not_in":{"type":"string","description":"The value must NOT be within the provided comma-delimited list of values.","uniqueKey":"phoneNumbers.not_in","typeLabel":"string"},"all":{"type":"string","description":"The value must contain all values provided in the comma-delimited list.","uniqueKey":"phoneNumbers.all","typeLabel":"string"},"exists":{"type":"boolean","description":"Only return documents where the value either exists (true) or does not exist (false).","uniqueKey":"phoneNumbers.exists","typeLabel":"boolean"}},"uniqueKey":"phoneNumbers","typeLabel":"object"}},"description":"Search for results fitting criteria, uses qs library for query string parsing","uniqueKey":"","typeLabel":"object"},"in":"query","name":"where","description":"Search for results fitting criteria, uses qs library for query string parsing"},"4a1a1dbe-c96e-4ee9-b331-1118c5e616b3":{"schema":{"type":"integer","isRequired":false,"description":"The number of levels of related objects to include in the response","uniqueKey":"","typeLabel":"integer"},"name":"depth","in":"query","required":false,"description":"The number of levels of related objects to include in the response"}},"responses":{"db354e55-03f4-4bd7-888b-baa422d5d703":{"description":"Customers Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$id":"Customer","required":["id"],"title":"Customer","type":"object","properties":{"id":{"type":"string","description":"Customer is uniquely identified by id","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"addresses":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","title":"Address","required":["id","city","zip","line1"],"example":{"id":"adr_2kj49d1msod2","zip":"62704","city":{"name":"Springfield","state":{"code":"IL"}},"line2":"Apt 201","line1":"456 Elm Street"},"properties":{"id":{"type":"string","description":"Address is uniquely identified by id","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.id","typeLabel":"string"},"city":{"oneOf":[{"type":"object","description":"Address is located in City","required":["state","name"],"properties":{"state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"object","title":"State","required":["code"],"properties":{"code":{"type":"string","description":"State is uniquely identified by State Code","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.0.state.oneOf.1.code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.0.state.oneOf.1","typeLabel":"State · object"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.0.state","typeLabel":"string | State · object"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.0","typeLabel":"object"},{"type":"object","title":"City","description":"Address is located in City","required":["state","name"],"example":{"name":"Springfield","state":{"code":"IL"}},"properties":{"state":{"oneOf":[{"type":"string","description":"City is uniquely identified by State","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"object","title":"State","description":"City is uniquely identified by State","required":["code"],"properties":{"code":{"type":"string","description":"State is uniquely identified by State Code","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.1.state.oneOf.1.code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.1.state.oneOf.1","typeLabel":"State · object"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.1.state","typeLabel":"string | State · object"},"name":{"type":"string","description":"City is uniquely identified by Name","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.1.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city.oneOf.1","typeLabel":"City · object"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.city","typeLabel":"object | City · object"},"zip":{"type":"string","description":"Address has ZIP","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.zip","typeLabel":"string"},"line1":{"type":"string","description":"Address has Address Line 1","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.line1","typeLabel":"string"},"line2":{"type":"string","description":"Address has Address Line 2","uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1.line2","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX].oneOf.1","typeLabel":"Address · object"}],"uniqueKey":"data.items.[INDEX].addresses.items.[INDEX]","typeLabel":"string | Address · object"},"description":"Customer is located at Addresses","uniqueKey":"data.items.[INDEX].addresses","typeLabel":"(string | Address · object)[]"},"phoneNumbers":{"type":"array","items":{"type":"string","pattern":"^\\+?1?[- ]?\\(?([0-9]{3})\\)?[- ]?([0-9]{3})-?([0-9]{4})$","uniqueKey":"data.items.[INDEX].phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Customer has Phone Number","uniqueKey":"data.items.[INDEX].phoneNumbers","typeLabel":"string[]"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"Customer · object"},"uniqueKey":"data","typeLabel":"Customer · object[]"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"page":{"type":"number","description":"Current page number","examples":[2],"uniqueKey":"page","typeLabel":"number"},"nextPage":{"oneOf":[{"type":"number","description":"`number` of next page, `null` if it doesn't exist","examples":[3],"uniqueKey":"nextPage.oneOf.0","typeLabel":"number"},{"type":"null","description":"`number` of next page, `null` if it doesn't exist","examples":[3],"uniqueKey":"nextPage.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextPage","typeLabel":"number | null"},"prevPage":{"oneOf":[{"type":"number","description":"`number` of previous page, `null` if it doesn't exist","examples":[1],"uniqueKey":"prevPage.oneOf.0","typeLabel":"number"},{"type":"null","description":"`number` of previous page, `null` if it doesn't exist","examples":[1],"uniqueKey":"prevPage.oneOf.1","typeLabel":"null"}],"uniqueKey":"prevPage","typeLabel":"number | null"},"totalPages":{"type":"number","description":"Total pages available, based upon the `limit`","examples":[3],"uniqueKey":"totalPages","typeLabel":"number"},"totalCount":{"type":"number","description":"Total available records within the database","examples":[25],"uniqueKey":"totalCount","typeLabel":"number"},"limit":{"type":"number","description":"Limit query parameter, defaults to `10`","examples":[10],"uniqueKey":"limit","typeLabel":"number"},"pagingCounter":{"type":"number","description":"`number` of the first record on the current page","examples":[11],"uniqueKey":"pagingCounter","typeLabel":"number"},"hasPrevPage":{"type":"boolean","description":"`true/false` if previous page exists","examples":[true],"uniqueKey":"hasPrevPage","typeLabel":"boolean"},"hasNextPage":{"type":"boolean","description":"`true/false` if next page exists","examples":[true],"uniqueKey":"hasNextPage","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"\u003cstring>","addresses":["\u003cstring>"],"phoneNumbers":["\u003cstring>"]}],"success":true,"page":2,"nextPage":3,"prevPage":1,"totalPages":3,"totalCount":25,"limit":10,"pagingCounter":11,"hasPrevPage":true,"hasNextPage":true}}},"exampleType":"generated"}},"exampleType":"generated"},"2378ff6e-8483-476b-bed5-0b6cb047c71b":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"error.code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"}},"examples":[{"error":{"code":401,"message":"Unauthorized"},"success":false}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":401,"message":"Unauthorized"},"success":false}}},"exampleType":"generated"}},"exampleType":"generated"},"434b5008-476d-46dd-8a29-c7358302a63b":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"error.code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"}},"examples":[{"error":{"code":429,"message":"Too Many Requests"},"success":false}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":429,"message":"Too Many Requests"},"success":false}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"97d902c7-7c79-48c5-91b0-8ede0ad052a3":{"url":"https://commerce.driv.ly/api"}},"schemas":{"4517e773-4abf-45ac-980a-fbda4ce1c568":{"type":"object","properties":{"and":{"type":"array","items":{"$circularRef":"4517e773-4abf-45ac-980a-fbda4ce1c568"}},"or":{"type":"array","items":{"$circularRef":"4517e773-4abf-45ac-980a-fbda4ce1c568"}},"id":{"type":"object","properties":{"equals":{"type":"string","description":"The value must be exactly equal."},"not_equals":{"type":"string","description":"The query will return all documents where the value is not equal."},"like":{"type":"string","description":"Case-insensitive string must be present. If string of words, all words must be present, in any order."},"contains":{"type":"string","description":"Must contain the value entered, case-insensitive."},"in":{"type":"string","description":"The value must be found within the provided comma-delimited list of values."},"not_in":{"type":"string","description":"The value must NOT be within the provided comma-delimited list of values."},"all":{"type":"string","description":"The value must contain all values provided in the comma-delimited list."},"exists":{"type":"boolean","description":"Only return documents where the value either exists (true) or does not exist (false)."}}},"addresses":{"type":"object","properties":{"equals":{"type":"array","description":"The value must be exactly equal."},"not_equals":{"type":"array","description":"The query will return all documents where the value is not equal."},"like":{"type":"string","description":"Case-insensitive string must be present. If string of words, all words must be present, in any order."},"contains":{"type":"string","description":"Must contain the value entered, case-insensitive."},"in":{"type":"string","description":"The value must be found within the provided comma-delimited list of values."},"not_in":{"type":"string","description":"The value must NOT be within the provided comma-delimited list of values."},"all":{"type":"string","description":"The value must contain all values provided in the comma-delimited list."},"exists":{"type":"boolean","description":"Only return documents where the value either exists (true) or does not exist (false)."}}},"phoneNumbers":{"type":"object","properties":{"equals":{"type":"array","description":"The value must be exactly equal."},"not_equals":{"type":"array","description":"The query will return all documents where the value is not equal."},"like":{"type":"string","description":"Case-insensitive string must be present. If string of words, all words must be present, in any order."},"contains":{"type":"string","description":"Must contain the value entered, case-insensitive."},"in":{"type":"string","description":"The value must be found within the provided comma-delimited list of values."},"not_in":{"type":"string","description":"The value must NOT be within the provided comma-delimited list of values."},"all":{"type":"string","description":"The value must contain all values provided in the comma-delimited list."},"exists":{"type":"boolean","description":"Only return documents where the value either exists (true) or does not exist (false)."}}}}}}},"originalFileLocation":"ai/Commerce.json"},"subdomain":"drivly","siteName":"Drivly Docs","title":"Get Customers - Drivly Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:48:18.035Z","originalFileLocation":"commerce/endpoints/deals/get-customers.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Drivly Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Customers - Drivly Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Drivly Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.driv.ly/commerce/endpoints/deals/get-customers\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://drivly.mintlify.app/_mintlify/api/og/v2?division=Deals\u0026amp;title=Get+Customers\u0026amp;theme=14367af80339ef3b766a97b8\u0026amp;signature=50d2b039b49eabe2cd5638218566fa575c8b1fe97fe015d7834f138d6b9fed66\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Customers - Drivly Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://drivly.mintlify.app/_mintlify/api/og/v2?division=Deals\u0026amp;title=Get+Customers\u0026amp;theme=14367af80339ef3b766a97b8\u0026amp;signature=50d2b039b49eabe2cd5638218566fa575c8b1fe97fe015d7834f138d6b9fed66\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Drivly Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00CAB9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.driv.ly/commerce/endpoints/deals/get-customers\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/commerce/endpoints/deals/get-customers.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.driv.ly/#organization\",\"name\":\"Drivly Docs\",\"url\":\"https://docs.driv.ly\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/drivly/lS-LOhC8keZU5zBZ/logo/light.svg?fit=max\u0026auto=format\u0026n=lS-LOhC8keZU5zBZ\u0026q=85\u0026s=2949247e5550eeee3c33c8516df55d81\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.driv.ly#website\",\"name\":\"Drivly Docs\",\"url\":\"https://docs.driv.ly\",\"publisher\":{\"@id\":\"https://docs.driv.ly/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers#webpage\",\"url\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers\",\"name\":\"Get Customers\",\"dateModified\":\"2026-01-06T22:48:18.035Z\",\"isPartOf\":{\"@id\":\"https://docs.driv.ly#website\"},\"breadcrumb\":{\"@id\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.driv.ly/commerce/endpoints/deals/get-deals\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Deals\",\"item\":\"https://docs.driv.ly/commerce/endpoints/deals/get-deals\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Customers\",\"item\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers#apireference\",\"headline\":\"Get Customers\",\"name\":\"Get Customers\",\"url\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers\",\"mainEntityOfPage\":{\"@id\":\"https://docs.driv.ly/commerce/endpoints/deals/get-customers#webpage\"},\"dateModified\":\"2026-01-06T22:48:18.035Z\",\"publisher\":{\"@id\":\"https://docs.driv.ly/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.driv.ly#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Drivly Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Drivly Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started/introduction"}]},{"tab":"Data","pages":[{"title":"Data","href":"/data/overview"}]},{"tab":"Services","pages":[{"title":"Services","href":"/services/overview"}]},{"tab":"Commerce","groups":[{"group":"Commerce","pages":[{"title":"Overview","mode":"wide","href":"/commerce/overview"},{"title":"Build","icon":"industry","href":"/commerce/build"},{"title":"Buy","icon":"pen-to-square","href":"/commerce/buy"},{"title":"Sell","icon":"sack-dollar","href":"/commerce/sell"},{"title":"Trade","icon":"car-side","href":"/commerce/trade"},{"title":"Broker","icon":"building-memo","href":"/commerce/broker"},{"title":"Dropship","icon":"truck-container","href":"/commerce/dropship"}]},{"group":"Resources","pages":[{"title":"Invoices","icon":"file-invoice-dollar","href":"/commerce/resources/invoices"}]},{"group":"API Reference","pages":[{"group":"Deals","pages":[{"openapi":"Commerce get /deals","title":"Get Deals","href":"/commerce/endpoints/deals/get-deals"},{"openapi":"Commerce post /deals","title":"Create a new Deal","href":"/commerce/endpoints/deals/create-a-new-deal"},{"openapi":"Commerce get /deals/{id}","title":"Retrieve a Deal","href":"/commerce/endpoints/deals/retrieve-a-deal"},{"openapi":"Commerce patch /deals/{id}","title":"Update an existing Deal","description":null,"href":"/commerce/endpoints/deals/update-an-existing-deal"},{"openapi":"Commerce get /customers","title":"Get Customers","href":"/commerce/endpoints/deals/get-customers"},{"openapi":"Commerce post /customers","title":"Create a new Customer","description":null,"href":"/commerce/endpoints/deals/create-a-new-customer"},{"openapi":"Commerce get /customers/{id}","title":"Retrieve a Customer","href":"/commerce/endpoints/deals/retrieve-a-customer"},{"openapi":"Commerce patch /customers/{id}","title":"Update an existing Customer","href":"/commerce/endpoints/deals/update-an-existing-customer"},{"openapi":"Commerce get /documents","title":"Get Documents","href":"/commerce/endpoints/deals/get-documents"},{"openapi":"Commerce post /documents","title":"Create a new Document","href":"/commerce/endpoints/deals/create-a-new-document"},{"openapi":"Commerce get /documents/{id}","title":"Retrieve a Document","href":"/commerce/endpoints/deals/retrieve-a-document"},{"openapi":"Commerce patch /documents/{id}","title":"Update an existing Document","href":"/commerce/endpoints/deals/update-an-existing-document"}]},{"group":"Trades","pages":[{"openapi":"Commerce get /trades","title":"Get Trades","href":"/commerce/endpoints/trades/get-trades"},{"openapi":"Commerce post /trades","title":"Add a new Trade","href":"/commerce/endpoints/trades/add-a-new-trade"},{"openapi":"Commerce get /trades/{customer}/{vehicle}","title":"Retrieve a Trade","href":"/commerce/endpoints/trades/retrieve-a-trade"},{"openapi":"Commerce patch /trades/{customer}/{vehicle}","title":"Update an existing Trade","href":"/commerce/endpoints/trades/update-an-existing-trade"},{"openapi":"Commerce get /tradepayoffbalances","title":"Get Trade Payoff Balances","href":"/commerce/endpoints/trades/get-trade-payoff-balances"},{"openapi":"Commerce post /tradepayoffbalances","title":"Add a new Trade Payoff Balance","href":"/commerce/endpoints/trades/add-a-new-trade-payoff-balance"},{"openapi":"Commerce get /tradepayoffbalances/{customer}/{vehicle}/{balance}","title":"Retrieve a Trade Payoff Balance","href":"/commerce/endpoints/trades/retrieve-a-trade-payoff-balance"},{"openapi":"Commerce patch /tradepayoffbalances/{customer}/{vehicle}/{balance}","title":"Update an existing Trade Payoff Balance","href":"/commerce/endpoints/trades/update-an-existing-trade-payoff-balance"}]},{"group":"Lead Events","pages":[{"openapi":"openapi get /leadEvents","title":"Find paginated Lead Events","href":"/commerce/endpoints/leadevents/find-paginated-lead-events"},{"openapi":"openapi post /leadEvents","title":"Create a new Lead Event","href":"/commerce/endpoints/leadevents/create-a-new-lead-event"},{"openapi":"openapi delete /leadEvents","title":"Delete multiple Lead Events","href":"/commerce/endpoints/leadevents/delete-multiple-lead-events"},{"openapi":"openapi patch /leadEvents","title":"Update multiple Lead Events","href":"/commerce/endpoints/leadevents/update-multiple-lead-events"},{"openapi":"openapi get /leadEvents/{id}","title":"Get a single Lead Event by its id","href":"/commerce/endpoints/leadevents/get-a-single-lead-event-by-its-id"},{"openapi":"openapi delete /leadEvents/{id}","title":"Deletes an existing Lead Event","href":"/commerce/endpoints/leadevents/deletes-an-existing-lead-event"},{"openapi":"openapi patch /leadEvents/{id}","title":"Updates a Lead Event","href":"/commerce/endpoints/leadevents/updates-a-lead-event"}]},{"group":"VDP Emails","pages":[{"openapi":"openapi get /vdpEmails","title":"Find paginated Vdp Emails","href":"/commerce/endpoints/vdpemails/find-paginated-vdp-emails"},{"openapi":"openapi post /vdpEmails","title":"Create a new Vdp Email","href":"/commerce/endpoints/vdpemails/create-a-new-vdp-email"},{"openapi":"openapi delete /vdpEmails","title":"Delete multiple Vdp Emails","href":"/commerce/endpoints/vdpemails/delete-multiple-vdp-emails"},{"openapi":"openapi patch /vdpEmails","title":"Update multiple Vdp Emails","href":"/commerce/endpoints/vdpemails/update-multiple-vdp-emails"},{"openapi":"openapi get /vdpEmails/{id}","title":"Get a single Vdp Email by its id","href":"/commerce/endpoints/vdpemails/get-a-single-vdp-email-by-its-id"},{"openapi":"openapi delete /vdpEmails/{id}","title":"Deletes an existing Vdp Email","href":"/commerce/endpoints/vdpemails/deletes-an-existing-vdp-email"},{"openapi":"openapi patch /vdpEmails/{id}","title":"Updates a Vdp Email","href":"/commerce/endpoints/vdpemails/updates-a-vdp-email"},{"openapi":"openapi get /vdpEmails/versions","title":"Vdp Email versions","href":"/commerce/endpoints/vdpemails/vdp-email-versions"},{"openapi":"openapi get /vdpEmails/versions/{id}","title":"Get a single Vdp Email version by its id","href":"/commerce/endpoints/vdpemails/get-a-single-vdp-email-version-by-its-id"},{"openapi":"openapi post /vdpEmails/versions/{id}","title":"Restore a Vdp Email version by its id","href":"/commerce/endpoints/vdpemails/restore-a-vdp-email-version-by-its-id"}]}]}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai/overview"}]}]},{"anchor":"Auth","icon":"user-shield","pages":[{"title":"Auth","href":"/developers/auth/overview"}]},{"anchor":"SDK","icon":"layer-group","pages":[{"title":"SDK","href":"/developers/sdk/overview"}]},{"anchor":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/developers/webhooks/overview"}]}]},"title":"Get Customers - Drivly Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}