EspoCRM Tool icon

EspoCRM Tool

CRUD no EspoCRM (entidades dinâmicas por instância)

Entidades → Ler todos registros

AI-generated

Summary

Lista registros da entidade escolhida no EspoCRM, com filtros, ordenação e seleção de atributos opcionais. Pode buscar páginas adicionais automaticamente ou emitir cada registro como um item separado.

Inputs

  • Entidade (required) — Entidade do EspoCRM cujos registros serão listados.
  • Opções: Não calcular total — Envia o cabeçalho X-No-Total: true para solicitar a listagem sem calcular o total.
  • Opções: Retornar lista como itens — Quando a resposta contiver list e total, emite cada entrada de list como um item; caso contrário, retorna a resposta completa.
  • Opções: Retornar tudo — Busca páginas sucessivas de até 200 registros, começando no offset informado, e agrega os registros em uma única resposta.
  • Opções: Tamanho Máx. — Limita o tamanho da página, até 200. O padrão efetivo é 200 quando o valor é zero ou não informado.
  • Opções: Deslocamento (offset) — Define a posição inicial da listagem; valores menores que zero são tratados como zero.
  • Opções: Ordenar por e Ordem — Ordena pelo campo escolhido em ordem crescente ou decrescente. A ordem só é enviada quando um campo de ordenação é selecionado.
  • Opções: Filtro Primário — Aplica um filtro primário disponível para a entidade.
  • Opções: Filtros Booleanos — Aplica os filtros booleanos selecionados para a entidade.
  • Opções: Filtro de Texto — Envia o texto informado como filtro de busca.
  • Opções: Atributos (attributeSelect) — Seleciona os atributos a incluir na resposta, enviados como uma lista separada por vírgulas.
  • Opções: Where Group (whereGroup) — Aceita um array JSON de condições whereGroup; valores que não resultem em um array são ignorados.

Output shape

Uma resposta de listagem por item de entrada, ou um item de saída por registro quando «Retornar lista como itens» estiver ativado.

Sem paginação automática, retorna o corpo da API, normalmente com list e total. Com «Retornar tudo», agrega os registros e retorna list e total; total será null se a API não fornecer um número. A paginação para quando uma página vem vazia ou incompleta, quando o total é atingido ou quando total é -2. A opção de emitir registros separados só se aplica quando a resposta contém list como array e a propriedade total.

Links

Discussion