Pular para o conteúdo

POST /v1/companies/search

POST
/v1/companies/search
curl --request POST \
--url https://seu-endereco-da-api/v1/companies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "filter": {}, "sort": "name_asc", "cursor": "example", "limit": 1 }'

Permissão que a Chave de acesso precisa: Ler empresas (companies:read).

Media typeapplication/json
object
filter
object
key
additional properties
any
sort
string
Allowed values: name_asc created_newest last_activity open_value_desc won_value_desc
cursor
string
limit
number
>= 1
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
name
required
string
document
required

CNPJ, digits only

string
nullable
website
required
string
nullable
email
required
string
nullable
phoneNumber
required
string
nullable
segment
required
string
nullable
size
required
string
nullable
Allowed values: micro pequena media grande
owner
required
object
id
required
string
name
required
string
nullable
avatarUrl
required
string
nullable
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
contactCount
required
number
openDealCount
required
number
openDealValueCents
required
number
wonValueCents
required
number
lastActivityAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
required
string
nullable

Example

{
"items": [
{
"size": "micro"
}
]
}