Skip to main content

Get a list of companies

Get a list of companies

Query Parameters
per_page number

Define the number of items per page, default is 100

page number

Define the page number, default is 1

term string

Search term

cpf_cnpj string

Filter by national registry number (CNPJ)

Responses
200

200 response

Schema OPTIONAL
object[]
national_registry_number string OPTIONAL

The National Registry Number of the company

alias_name string OPTIONAL

The alias name of the company

complete_name string OPTIONAL

The complete name of the company

service_types string OPTIONAL

The service types of the company, comma separated values

is_active boolean OPTIONAL

Indicates if the company is active

epr_code string OPTIONAL

The EPR code of the company

cost_center string OPTIONAL

The cost center of the company

address object OPTIONAL

The address of the company

street string OPTIONAL

The street of the address

district string OPTIONAL

The district of the address

number string OPTIONAL

The number of the address

zip_code string OPTIONAL

The zip code of the address

city string OPTIONAL

The city of the address

state string OPTIONAL

The state of the address

country string OPTIONAL

The country of the address