Listar estabelecimentos

🔽
GET urlServidor/v1/marketplace/establishments

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/establishments' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Query

Key	Tipo	Obrigatório	Descrição
filters	string	Não	JSON com filtros. Campos filtráveis: status, type, risk. Exemplo: { "status": "CREATED" }.
search	string	Não	Valor a ser pesquisado em vários campos. Campos pesquisados 'id','name1','name2','document',phone_number','slug','email',
perPage	number	Não	Limitado ao máximo de 100 por página.
page	number	Não	Página atual.
sorters	string	Não	JSON com lista de ordenadores. Campos ordenáveis: id, created_at, updated_at, name. Exemplo: [{"column":"created_at","direction":"DESC"}].

Exemplo de Response de sucesso.

{
    "total": 1,
    "page": 1,
    "perPage": 20,
    "lastPage": 1,
    "data": [
        {
            "id": 155233,
            "type": "BUSINESS",
            "first_name": "Webhook Notificacoes API",
            "last_name": "Webooks Notificações",
            "document": "11876222000199",
            "birthdate": "2025-03-07",
            "phone_number": "27900000001",
            "active": true,
            "revenue": "1000",
            "format": "LTDA",
            "email": "[email protected]",
            "risk": "LOW",
            "status": "APPROVED",
            "address": {
                "zip_code": "29090390",
                "street": "Rua 1301",
                "number": "471",
                "neighborhood": "Centro",
                "city": "Vitoria",
                "state": "ES",
                "complement": null
            },
            "category": "Serviços Profissionais, Categorias Especiais - Outros",
            "code": "FRFIU8BW",
            "created_at": "2025-08-25T18:36:47.000Z",
            "updated_at": "2025-08-25T18:42:03.000Z",
            "deleted_at": null,
            "responsible": {
                "id": 309,
                "first_name": "Antonio Joao",
                "email": "[email protected]"
                "document": "12345678911",
                "phone": "2790000-0001",
                "birthdate": "1997-04-16"
            }
    ]
}

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.