GET
/
salesreps
curl --request GET \
  --url https://commerce.driv.ly/api/salesreps
{
  "data": [
    {
      "id": "srep_8f9v2j1kd92j",
      "emails": [
        "sales.rep@example.com",
        "contact@example.com"
      ],
      "lastName": "Smith",
      "firstName": "Alice",
      "templates": [
        "Welcome Template",
        "Follow-up Template"
      ],
      "creditBands": [
        "Prime",
        "Subprime"
      ],
      "primaryEmail": "sales.rep@example.com",
      "phoneNumbers": [
        "+1-555-0123",
        "+1-555-0456"
      ],
      "primaryPhoneNumber": "+1-555-0123",
      "isAcceptingNewLeads": true
    }
  ],
  "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

Sales Reps Found

The response is of type object.