Listar Estabelecimentos
GET
/v1/marketplace/establishments
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/marketplace/establishments?page=1&search=like "a%"&filters={"type": "BUSINESS"}&sorters=[ { "column": "id", "direction": "ASC" } ]&perPage=10' \
--header 'integration-key: {{integration-key}}' \
--header 'x-token: {{x-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{}'Response Response Example
{"total":2,"page":1,"perPage":10,"lastPage":1,"data":[{"id":155115,"type":"BUSINESS","first_name":"Minha Empresa LTDA","last_name":"Minha Empresa","document":"65735888000156","birthdate":"2020-05-05","phone_number":"11999999999","active":true,"revenue":"10000","format":"LTDA","email":"teste@inovpay.com.br","risk":"PENDING","status":"RISK_ANALYSIS","address":{"zip_code":"04845000","street":"Rua Teste Cliente","number":"300","neighborhood":"Sé","city":"São Paulo","state":"SP","complement":"200"},"category":"Instituições Financeiras - Mercadorias e Serviços","created_at":"2025-05-16T15:34:05.000Z","updated_at":"2025-05-16T15:34:05.000Z","deleted_at":null,"responsible":{"id":229,"first_name":"Socio","email":"teste@inovpay.com.br","document":"35117000005","phone":"11999999999","birthdate":"1994-09-06"}},{"id":155104,"type":"BUSINESS","first_name":"INOVPAY","last_name":"INOVPAY FINTECH LTDA","document":"54348971000156","birthdate":"2024-03-15","phone_number":"13999999999","active":true,"revenue":"200000","format":"ME","email":"contato@inovpay.com.br","risk":"LOW","status":"APPROVED","address":{"zip_code":"11050201","street":"Avenida Washington Luís","number":"173","neighborhood":"Vila Mathias","city":"Santos","state":"SP","complement":null},"category":"A/D DE EQUIPAMENTOS DE FOTOGRAFIA, CÓPIA E MICROFILME","created_at":"2025-04-04T12:50:40.000Z","updated_at":"2025-04-04T12:54:07.000Z","deleted_at":null,"responsible":{"id":210,"first_name":"Socio Inovpay","email":"contato@inovpay.com.br","document":"94259820079","phone":"13999999999","birthdate":"1985-01-17"}}]}Requisição
Parâmetros Query
page
string
opcional
Exemplo:
1
search
string
opcional
'id','name1','name2','document',phone_number','slug','email',
Exemplo:
like "a%"
filters
string
opcional
Exemplo:
{"type": "BUSINESS"}
sorters
string
opcional
Exemplo:
[ { "column": "id", "direction": "ASC" } ]
perPage
string
opcional
Exemplo:
10
Parâmetros Header
integration-key
string
requerido
Exemplo:
{{integration-key}}
x-token
string
requerido
Exemplo:
{{x-token}}
Parâmetros Bodyapplication/json