Skip to main content
GET
List companies

Authorizations

Authorization
string
header
required

OAuth2 Authorization Code flow

Query Parameters

expand
string

Comma-separated fields to expand. Supports selection with brackets (e.g., "createdBy,updatedBy" or "targets.company[icon,tradeName]").

Example:

"createdBy"

page_size
number
default:20

Number of items to return per page

Required range: 1 <= x <= 100
Example:

100

start_cursor
string

Opaque cursor for pagination. Use the next_cursor from previous response.

Example:

"eyJjcmVhdGVkX3RpbWUiOiIyMDI0LTExLTE1VDEwOjAwOjAwLjAwMFoiLCJpZCI6InBhZ2VfYWJjMTIzIn0="

Search by trade name, legal name or document (CNPJ)

user
string

Filter by creator user ID

document
string

Filter by company document (CNPJ)

fields
string

Comma-separated company fields to include in the response. Example: "icon,legalName,tradeName,document".

date_from
string

Filter by creation date from (YYYY-MM-DD)

date_to
string

Filter by creation date to (YYYY-MM-DD)

archived
boolean

Filter by archived status. If omitted, defaults to non-archived only.

address_state
string

Filter by address state (UF). Example: "SP"

main_cnae
string

Filter by main CNAE code. Example: "6201501" or "6201-5/01"

secondary_cnae
string

Filter by secondary CNAE code. Example: "6201501" or "6201-5/01"

registration_status
string

Filter by registration status (situação cadastral). Example: "Ativa"

is_headquarter
boolean

Filter by headquarter status (matriz). true = matriz, false = filial.

sort
string

Sort field and direction. Format: "field:direction". Allowed fields: created_at. Directions: asc, desc. Default: created_at:desc

Response

List of companies

object
string
required
Example:

"list"

results
object[]
required
has_more
boolean
required
next_cursor
string | null
type
string