GET /v1/companies
GET
/v1/companies
const url = 'https://seu-endereco-da-api/v1/companies';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/companies \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler empresas (companies:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”q
string
cursor
string
limit
number
Responses
Seção intitulada “Responses”Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
name
required
string
document
required
CNPJ, digits only
string
website
required
string
email
required
string
phoneNumber
required
string
segment
required
string
size
required
string
owner
required
object
id
required
string
name
required
string
avatarUrl
required
string
origin
required
object
id
required
string
name
required
string
color
required
string
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
contactCount
required
number
openDealCount
required
number
openDealValueCents
required
number
wonValueCents
required
number
lastActivityAt
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
required
string
Example
{ "items": [ { "size": "micro" } ]}