Companies

List companies

GET companies(admin)

Endpoint

GET /api/v1/companies

Parameters

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

Request

Route

GET /api/v1/companies

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjkiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NTMyNjYxNzEsImV4cCI6MTc1NTg1ODE3MSwianRpIjoiZGIzOTc0NmMtMDUzYy00YjE3LWE4YTAtNjQ4ODA4NGVmZDFkIn0.drNStU_fHwdlJCXbZFSSurVCkK6zobw5e0ytcschl3w
Host: example.org
Cookie:

Query Parameters

{}=

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: 3
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"bfe6dfed5b47cbb79ec9125621e39271"
cache-control: max-age=0, private, must-revalidate
x-request-id: f520a70a-6371-4183-8a30-423c0c6fc758
x-runtime: 0.023738
content-length: 1014

Body

{
  "companies": [
    {
      "id": 28,
      "active_jobs_count": 2,
      "address": "43491 Frami Roads, Adanfurt, ND TS8N 0XS",
      "billing_phone_number": "0915 801 8444",
      "created_at": "2025-07-23T10:22:51.660Z",
      "drivers_count": 3,
      "frozen": null,
      "invoice_email": "alex.mayer@torp.example",
      "jobs_count": 3,
      "name": "Nolan, Marquardt and Pagac",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 29,
      "active_jobs_count": 0,
      "address": "2864 Leslie Land, Loweborough, OH W0 6AJ",
      "billing_phone_number": "0500 631781",
      "created_at": "2025-07-23T10:22:51.675Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "altagracia_fritsch@rohan.example",
      "jobs_count": 0,
      "name": "Vandervort, Grady and Quitzon",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 30,
      "active_jobs_count": 0,
      "address": "Apt. 385 8823 Sawayn Valleys, West Karie, LA O2 8JL",
      "billing_phone_number": "01415 674485",
      "created_at": "2025-07-23T10:22:51.688Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "shaun@dicki-auer.test",
      "jobs_count": 0,
      "name": "Johnson, Bayer and Kilback",
      "rejection_reason": null,
      "timer": 86400
    }
  ]
}