---
title: "List companies"
method: GET
path: "/companies"
tags: ["Companies"]
---

# List companies

`GET /companies`

## Request

- Base URL: `https://joinways.app/api/v1`
- URL: `https://joinways.app/api/v1/companies`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://joinways.app/oauth/authorize`, token URL `https://joinways.app/api/oauth/token`, scopes: `mcp.read`)

Client companies of the workspace, by name by default. **Role permission:** none (any member).

## Query parameters

- `page` integer
- `per_page` integer
- `sort` 'name' | 'created_at' | 'updated_at' | 'city'
- `order` 'asc' | 'desc'
- `q` string
- `country` string[]
- `has_website` boolean

## Response `200`

Page of companies.

- object: Envelope wrapping a page of results.
  - `data` Company[], required: The page of results (item type depends on the endpoint).
    - `id` string, uuid
    - `name` string
    - `registration_number` string, nullable: Company registration number (e.g. SIRET).
    - `vat_number` string, nullable: VAT / tax identifier.
    - `website` string, nullable
    - `phone` string, nullable
    - `address` string, nullable
    - `city` string, nullable
    - `postal_code` string, nullable
    - `state` string, nullable: State / province / region (US state, Canadian province…).
    - `country` string, nullable
    - `enrichment_status` string, nullable: Automatic enrichment of the company profile.
    - `enrichment_completed_at` string, date-time, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `pagination` object, required
    - `page` integer, required: Current 1-based page.
    - `per_page` integer, required: Items per page.
    - `total` integer, nullable, required: Total matching items across all pages (`null` only on a page past the last one, when unknown).
    - `total_pages` integer, nullable, required

## Other responses

- `401`: Missing, invalid, expired or revoked bearer token (`unauthorized`).
- `429`: Too many requests (`rate_limited`). `details.reason`: `per-ip`, `per-account-minute`, `per-account-day`, or `email_rate_limited` (email budget). Always carries `Retry-After`: wait that many seconds.

---

[API](https://skmtc.dev/joinways/apis/joinways-public-api.md) · [All operations](https://skmtc.dev/joinways/apis/joinways-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/joinways/apis/joinways-public-api/revisions/39e84309953e?raw)