GET
/
consumers
curl --request GET \
  --url https://commerce.driv.ly/api/consumers
{
  "data": [
    {
      "id": "con_2k4jd93vsd82",
      "ssn": "123-45-6789",
      "email": "john.doe@example.com",
      "lastName": "Doe",
      "birthDate": "1984-09-20",
      "firstName": "John",
      "phoneNumber": "555-0199"
    }
  ],
  "success": true,
  "page": 2,
  "nextPage": 3,
  "prevPage": 1,
  "totalPages": 3,
  "totalCount": 25,
  "limit": 10,
  "pagingCounter": 11,
  "hasPrevPage": true,
  "hasNextPage": true
}

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

​
sort
string

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.

​
limit
number

Limit number of results, default 10

​
where
object

Search for results fitting criteria, uses qs library for query string parsing

Response

200
application/json

Consumers Found

The response is of type object.