Atualizado em 17 de outubro de 2026
Listar clientes
Lista os clientes do cadastro central, com filtros e paginação. É o primeiro passo para localizar um cliente e usar o id dele em pedidos, tarefas e publicações.
Considerações
- Exige o escopo
clients:read. - Filtros:
kind(clientoulead),type(pfoupj),status(ativo/inativo),group_id,search(nome, e-mail, CPF ou CNPJ) eper_page(de 1 a 100, padrão 20). - A resposta vem no envelope paginado:
data,linksemeta. - Para um cliente só, use
GET /clients/{client}.
Referência
GET /clients na Referência da API GET /clients/{client} na Referência da APIComo fazer
Consulte /clients, opcionalmente com filtros na query:
cURL
curl "$MICORE_BASE_URL/clients?kind=client&type=pf&per_page=20" \
-H "Authorization: Bearer $MICORE_TOKEN" \
-H "Accept: application/json"Resposta
Resposta · 200
{
"data": [
{
"id": 42,
"kind": "client",
"type": "pf",
"name": "Maria Oliveira",
"document": { "type": "cpf", "value": "12345678909" },
"email": "maria@exemplo.com",
"status": true,
"group_id": 1,
"created_at": "2026-10-17T09:00:00-03:00",
"updated_at": "2026-10-17T09:00:00-03:00"
}
],
"links": { "first": "...", "last": "...", "prev": null, "next": null },
"meta": { "current_page": 1, "per_page": 20, "total": 1 }
}Precisa de ajuda?Use o request ID e abra um chamado no miCore se encontrar uma divergência.