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.eyJzdWIiOiIxMjkiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NDg1MTY0OTYsImV4cCI6MTc1MTEwODQ5NiwianRpIjoiZTFjZDBmNDYtZjhiNS00ZTRhLThlM2YtMjZlMTg0NWJlMzIyIn0.x4uPqPbpLvRztoO4w-xQbGUU56V-XFU6BKeGv7quiNU
Host: example.org
Cookie:

Query Parameters

{}=

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/"aeff8bc208b731192b1835476ebd95c2"
cache-control: max-age=0, private, must-revalidate
x-request-id: 3840d793-d278-4210-836f-aa432d9dcfbf
x-runtime: 0.073244
content-length: 1020

Body

{
  "companies": [
    {
      "id": 28,
      "active_jobs_count": 2,
      "address": "Suite 434 66112 Conn Village, East Anglaland, IN LB6 3WB",
      "billing_phone_number": "0119 767 7939",
      "created_at": "2025-05-29T11:01:36.356Z",
      "drivers_count": 3,
      "frozen": null,
      "invoice_email": "leonora@bogan.example",
      "jobs_count": 3,
      "name": "Brakus Group",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 29,
      "active_jobs_count": 0,
      "address": "Apt. 515 68541 Estella River, New Aubrey, WA D0 8QJ",
      "billing_phone_number": "0114 662 9424",
      "created_at": "2025-05-29T11:01:36.367Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "stanford@mayert.test",
      "jobs_count": 0,
      "name": "Heathcote, Reinger and Abernathy",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 30,
      "active_jobs_count": 0,
      "address": "23113 Dach Valley, Toddside, AK A4B 4YL",
      "billing_phone_number": "01269 27321",
      "created_at": "2025-05-29T11:01:36.379Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "cornelius_schmidt@vandervort.test",
      "jobs_count": 0,
      "name": "Marks, Hettinger and Schinner",
      "rejection_reason": null,
      "timer": 86400
    }
  ]
}