GET
/
affiliates
Get Affiliates
curl --request GET \
  --url https://commerce.driv.ly/api/affiliates
{
  "data": [
    {
      "id": "com_9j3k2dls0j29",
      "name": "Auto Sales Co.",
      "address": "123 Main St, Anytown, USA",
      "locations": [
        {
          "id": "loc_k2j3l9s9d4j0",
          "companyId": "com_9j3k2dls0j29",
          "address": "123 Main St, Anytown, USA",
          "phone": "+1234567890"
        }
      ]
    }
  ],
  "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

Affiliates Found

The response is of type object.