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.eyJzdWIiOiIxMTgiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3Mzc1NTE1NTIsImV4cCI6MTc0MDE0MzU1MiwianRpIjoiZjQ3MGM4NGUtODQyNS00MzljLWI5YzctNTAzZGE2NGVhOTM5In0.el6V428r4FF4xIPyT_11Cw-H5FhSEJRj9lRWIDJu9Ng
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/"375451987d8b881db19193e47806fd3b"
cache-control: max-age=0, private, must-revalidate
x-request-id: 7de1c915-9bc2-4d15-8c8c-c3515e806254
x-runtime: 0.028312
content-length: 990

Body

{
  "companies": [
    {
      "id": 23,
      "active_jobs_count": 2,
      "address": "Suite 920 3081 Eunice Ports, Ernsermouth, NH WG5E 2NJ",
      "billing_phone_number": "01501 14016",
      "created_at": "2025-01-22T13:12:32.274Z",
      "drivers_count": 3,
      "frozen": null,
      "invoice_email": "wilfred_boyle@lubowitz-lowe.test",
      "jobs_count": 3,
      "name": "Feest Inc",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 24,
      "active_jobs_count": 0,
      "address": "1515 Elke Turnpike, West Ethel, VA ZM8W 4ND",
      "billing_phone_number": "01815 721751",
      "created_at": "2025-01-22T13:12:32.286Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "peter_connelly@schuppe.test",
      "jobs_count": 0,
      "name": "Abernathy-Krajcik",
      "rejection_reason": null,
      "timer": 86400
    },
    {
      "id": 25,
      "active_jobs_count": 0,
      "address": "615 Carmine Green, New Clyde, GA WC79 8XJ",
      "billing_phone_number": "0800 962 5971",
      "created_at": "2025-01-22T13:12:32.298Z",
      "drivers_count": 0,
      "frozen": null,
      "invoice_email": "britt@wiza.test",
      "jobs_count": 0,
      "name": "Goodwin, Olson and Schimmel",
      "rejection_reason": null,
      "timer": 86400
    }
  ]
}