Favourite Drivers

Get current operator company’s favourite drivers

GET favourite drivers

Endpoint

GET /api/v1/favourite_drivers

Parameters

Name Description
by_name Filter by driver name
page Page number
per_page Number of items per page

Request

Route

GET /api/v1/favourite_drivers?by_name=John&by_state=former

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIzODQiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NjM2MjYzNjksImV4cCI6MTc2NjIxODM2OSwianRpIjoiYTBiYWM5ZTQtMmRiYi00OTBlLTg2MDgtODczZDRiOTM4MDFkIn0.8AnbjJ4tQ1Vo7lvFPEw-B_W049lx3biZMNaQ6zys36Y
Host: example.org
Cookie:

Query Parameters

by_name=John
by_state=former

Body

{
}

Response

Simulated Response

Status

200

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
per-page: 20
total: 2
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"098677d0fc84817116daeb927e4117f4"
cache-control: max-age=0, private, must-revalidate
x-request-id: f5888d54-35d9-4f31-9c0b-767716288c44
x-runtime: 0.032329
content-length: 399

Body

{
  "favourite_drivers": [
    {
      "id": 19,
      "chat_id": 227,
      "driver": {
        "id": 386,
        "financial_company_id": null,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 125,
        "referral_code": "388400"
      },
      "job_name": "Investor Legal Designer"
    },
    {
      "id": 20,
      "chat_id": 229,
      "driver": {
        "id": 387,
        "financial_company_id": null,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 126,
        "referral_code": "065932"
      },
      "job_name": "Advertising Developer"
    }
  ]
}