companies

List Companies

get/api/v1/companies/

Request

Base URL
https://usebolsai.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/usebolsai/apis/bolsai/docs/api/v1/companies/get.ts
A function with typed inputs. Its response is checked against the schema.

sectorstring nullable

Filter by sector

statusstring nullable

Filter by status (e.g. ATIVO)

searchstring nullable

Search corporate or trade name

limitinteger

offsetinteger

formatstring

Response format: json or csv

Successful Response

countinteger required

totalinteger required

offsetinteger required

limitinteger required

No recorded changes to this operation across all 14 revisions of this API.