Companies

List companies

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

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)

Query parameters

pageinteger

1-based page number.

per_pageinteger

Items per page.

sort'name' | 'created_at' | 'updated_at' | 'city'

Field to sort by. Any other value sorts by name.

order'asc' | 'desc'
qstring

Case-insensitive match on the name.

countrystring[]

One or more countries as stored (repeat the parameter or separate with commas).

has_websiteboolean

true only companies with a website, false only those without.

Response

Page of companies.

Example response

{
  "data": [
    {
      "name": "Acme",
      "vat_number": "FR12345678901",
      "website": "https://acme.com",
      "city": "Paris",
      "country": "FR"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 1234,
    "total_pages": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.