Listar clientes
Lista os clientes que o chamador alcança: todos para um master, os da carteira para um administrador de revenda, e o próprio cliente para um usuário de cliente. dealer_id e q (nome ou slug) estreitam dentro do alcance; status filtra ativo (padrão), inativo ou todos. dealer_id é uma interseção com o alcance: um usuário de cliente pode indicar a própria revenda; uma revenda fora do alcance responde 404, como uma que não existe.
Autorização
bearer tenants:readCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: tenants:read
Parâmetros de consulta
Estreita para uma revenda (só faz sentido no alcance de plataforma).
int64active (padrão), inactive ou all.
Valor em
- "active"
- "inactive"
- "all"
Busca por nome ou slug.
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/tenants"{ "data": [ { "chatwoot_account_id": 0, "created_at": "2019-08-24T14:15:22Z", "dealer_id": 0, "id": 0, "is_active": true, "name": "string", "settings": {}, "slug": "string", "subdomain": "string", "updated_at": "2019-08-24T14:15:22Z" } ], "page": { "has_more": true, "next_cursor": "string" }}