Search companies
POST/v1/company/searchSearch companies by name, cnpj, state, city, neighborhood, street, number, complement, zip code, phone, email, website, and contact name
Requisição
Parâmetros Query
page
integer <int32>
opcional
Padrão:
0
perPage
integer <int32>
opcional
Padrão:
10
Parâmetros Bodyapplication/json
filters
array[object (SearchFilterRequest) {4}]
opcional
The filters to be used in the search
filter_key
string
opcional
The key to search for
value
object
opcional
The value to search for
operation
enum<string>
opcional
The comparison used to search for the term
Valores permitidos:
eqnegtgeltlecnicbwibewiencbnennunn
data_option
enum<string>
opcional
The option used to combine the search criteria
Valores permitidos:
allany
sorts
array[object (SortSearchRequest) {2}]
opcional
The sorts to be used in the search
sort
string
opcional
The field to sort the results by
direction
enum<string>
opcional
The direction to sort the results by
Valores permitidos:
ascdesc
Exemplo
{
"filters": [
{
"filter_key": "string",
"value": {},
"operation": "eq",
"data_option": "all"
}
],
"sorts": [
{
"sort": "string",
"direction": "asc"
}
]
}Exemplos de Requisição
Respostas
OK(200)
Pedido inválido(400)
Código HTTP: 200
Tipo de Conteúdo: JSONapplication/json
Companies found
Esquema de Dados
currentPage
integer <int32>
opcional
perPage
integer <int32>
opcional
total
integer <int64>
opcional
items
array[object (SearchCompanyResponse) {5}]
opcional
id
string
opcional
name
string
opcional
description
string
opcional
cnpj
string
opcional
address
object (AddressResponse)
opcional
Exemplo
{
"currentPage": 0,
"perPage": 0,
"total": 0,
"items": [
{
"id": "string",
"name": "string",
"description": "string",
"cnpj": "string",
"address": {
"street": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string",
"zip_code": "string"
}
}
]
}Last modified: 4 months ago