Companies

List entity companies

Returns a paginated list of companies associated with the authenticated entity. Use the cursor parameter to paginate through results.

⚠️ Multi-entity clients only. This endpoint is restricted to clients with a multi-entity credential. Single-entity clients will receive a 400: operation not available error. If you are a single-entity client, use GET /v1/employees instead to retrieve your employees directly.

get/v1/companies

Request

Base URL
https://api.clients.wellhub.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/wellhub/apis/integrations-api/docs/v1/companies/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

cursorstring

Pagination cursor returned from the previous response. Omit to retrieve the first page.

Response

OK. Returns a paginated list of companies.

cursorstring nullable

Cursor for fetching the next page of results. null if there are no more results.

Example response

{
  "data": [
    {
      "company_name": "Acme Corp",
      "company_tax_id": "12.345.678/0001-99"
    }
  ]
}

Changes

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