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.eyJzdWIiOiIxMjkiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NjA5NTA0MzUsImV4cCI6MTc2MzU0MjQzNSwianRpIjoiMzg5MTVmM2UtY2ZkZS00M2I2LTkxNTktNDU5ZTY1ZWUwN2UzIn0.kx7CcMXnexouLkH4kPHOrCIRZ4L10JdGgsoxUgUW2bc
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/"cc55e4eec12f21ebf1f5caf11584f13f"
cache-control: max-age=0, private, must-revalidate
x-request-id: 02b5a397-de26-4067-b217-87f4848d9b42
x-runtime: 0.026681
content-length: 1016

Body

{
  "companies": [
    {
      "id": 28,
      "active_jobs_count": 2,
      "address": "9294 Gottlieb Lights, West Janayborough, KY ZT7R 6BW",
      "billing_phone_number": "0896 497 9553",
      "created_at": "2025-10-20T08:53:55.224Z",
      "drivers_count": 3,
      "frozen": null,
      "invoice_email": "hector@dubuque.test",
      "jobs_count": 3,
      "name": "Gusikowski Group",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 29,
      "active_jobs_count": 0,
      "address": "882 Rosalind Neck, South Leroyfort, VT TY6P 8BG",
      "billing_phone_number": "0341 817 0763",
      "created_at": "2025-10-20T08:53:55.236Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "bryanna_gutkowski@reynolds.example",
      "jobs_count": 0,
      "name": "Hand Inc",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 30,
      "active_jobs_count": 0,
      "address": "Suite 467 95017 Jayne Island, Dannystad, MS W8 1ZH",
      "billing_phone_number": "0381 527 5062",
      "created_at": "2025-10-20T08:53:55.248Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "lyndsay.jones@carter.example",
      "jobs_count": 0,
      "name": "O'Connell, Harris and Schamberger",
      "rejection_reason": null,
      "timer": 86400
    }
  ]
}