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.eyJzdWIiOiIxMjkiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NDI0NjQ5MDcsImV4cCI6MTc0NTA1NjkwNywianRpIjoiODlmMzU3YTQtNzljZC00YTgwLThkNWYtMzU2ZjA0MTViMTlkIn0.f_QdzoVunxOcJwv4bX4u5mp89b-MroXD0-yldoncJNg
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/"fde0c300e216e2d3b8b87d3f22be92ba"
cache-control: max-age=0, private, must-revalidate
x-request-id: a59988e3-b178-442b-9369-e82a06a1e230
x-runtime: 0.052998
content-length: 999

Body

{
  "companies": [
    {
      "id": 28,
      "active_jobs_count": 2,
      "address": "5941 Jerald Hill, Lake Armandatown, NE UN3M 1XL",
      "billing_phone_number": "01189 06165",
      "created_at": "2025-03-20T10:01:47.753Z",
      "drivers_count": 3,
      "frozen": null,
      "invoice_email": "lahoma.doyle@krajcik.example",
      "jobs_count": 3,
      "name": "Borer-Balistreri",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 29,
      "active_jobs_count": 0,
      "address": "Suite 792 948 Benny Place, North Ariana, MS US2E 3AN",
      "billing_phone_number": "0800 996732",
      "created_at": "2025-03-20T10:01:47.765Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "leta_conroy@stark-dicki.test",
      "jobs_count": 0,
      "name": "Walker-Carter",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 30,
      "active_jobs_count": 0,
      "address": "Apt. 708 37039 Sam Lights, Romagueraview, AZ WA5 0FU",
      "billing_phone_number": "0500 316774",
      "created_at": "2025-03-20T10:01:47.776Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "samual.mayer@connelly.example",
      "jobs_count": 0,
      "name": "Ebert Group",
      "rejection_reason": null,
      "timer": 86400
    }
  ]
}