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.eyJzdWIiOiIxMjkiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NjM2MjYzNjMsImV4cCI6MTc2NjIxODM2MywianRpIjoiYjIyYmZiZDItOWJmYy00ZmIyLTlkZGUtZGZjZWVkNGQyMjc2In0.79qkIbYJabZ5Y9H0YiAxQUwuwxvAVfhp_ADncjoFqSM
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/"045ca9e241c2d39c1e42e3b9cc81617c"
cache-control: max-age=0, private, must-revalidate
x-request-id: 6d753927-3464-4295-86e0-e7a08129d7bb
x-runtime: 0.030281
content-length: 988

Body

{
  "companies": [
    {
      "id": 28,
      "active_jobs_count": 2,
      "address": "Apt. 930 946 Osinski Creek, New Wilson, MI Z9 0JN",
      "billing_phone_number": "055 3316 5382",
      "created_at": "2025-11-20T08:12:43.365Z",
      "drivers_count": 3,
      "frozen": null,
      "invoice_email": "paris@leffler.example",
      "jobs_count": 3,
      "name": "Tremblay and Sons",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 29,
      "active_jobs_count": 0,
      "address": "7452 Streich Plaza, Boscoport, DE EW9 0XZ",
      "billing_phone_number": "0800 877774",
      "created_at": "2025-11-20T08:12:43.377Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "buddy.dare@sawayn.example",
      "jobs_count": 0,
      "name": "Abbott-Thiel",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 30,
      "active_jobs_count": 0,
      "address": "Suite 341 2533 Orlando Squares, New Deadrachester, CT Y8 8BX",
      "billing_phone_number": "0340 330 1602",
      "created_at": "2025-11-20T08:12:43.388Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "clarisa_okuneva@bode.test",
      "jobs_count": 0,
      "name": "Spencer LLC",
      "rejection_reason": null,
      "timer": 86400
    }
  ]
}