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.eyJzdWIiOiIzNzQiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NTMyNjYxNzgsImV4cCI6MTc1NTg1ODE3OCwianRpIjoiN2MyZGNjMzItMjVlNC00NGJkLThhNDctNDViZWNkYzQwMjc1In0.WXo6-LodPcUMZ4bfsuUj3VbmIS7HZC_WbHChbW_NeM8
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/"a4cdc3464af80c62c24ac89bae897c87"
cache-control: max-age=0, private, must-revalidate
x-request-id: 57f40e3b-1da4-4596-b4fe-925c895090d7
x-runtime: 0.026407
content-length: 340

Body

{
  "favourite_drivers": [
    {
      "id": 19,
      "chat_id": 221,
      "driver": {
        "id": 376,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 119,
        "referral_code": "820875"
      },
      "job_name": "Human Design Specialist"
    },
    {
      "id": 20,
      "chat_id": 223,
      "driver": {
        "id": 377,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 120,
        "referral_code": "426541"
      },
      "job_name": "Product Technician"
    }
  ]
}