Returns the list of Customers associated with a dealership

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

dealership_id
integer
required
The id of the dealership

sort
string
enum
The sort order for each sort field MUST be ascending unless it is prefixed with a minus ("-"), in which case it MUST be descending.

amount_due
boolean
Filter customers to those that have or have no amount due
truefalse

per_page
integer
Number of records returned in a collection in the response

page
integer
Page number returned from the collection based on the total records and records per response

api-version
integer
required
Target API version

accept
string
enum
Defaults to application/json
Generated from available response content types

``200 Success

array of objects

object

id
integer

amount_due
string

complete_profile
boolean

email
string | null

first_name
string

language
string
enum
The preferred language
en``fr

last_name
string

permitted_to_rent
boolean

phone_number
string

ccpa
boolean

links
object
links object

has_ongoing_contracts
boolean

``401 Unauthorized

``403 Forbidden

``404 Not found

``406 Not Acceptable

curl --request GET \
     --url https://api.dealerware.com/admin/dealerships/dealership_id/customers \
     --header 'accept: application/json'
[
  {
    "id": 12,
    "amount_due": 30.05,
    "complete_profile": true,
    "email": "dusty.rhodes@gmail.com",
    "first_name": "Dusty",
    "language": "en",
    "last_name": "Rhodes",
    "permitted_to_rent": true,
    "phone_number": 5128675309,
    "ccpa": true,
    "links": {
      "dealership": {
        "id": 2,
        "href": "https://api.dw-tst.com/admin/some_resources/2"
      }
    },
    "has_ongoing_contracts": true
  }
]