Actions14
- Entidades Actions
- Documentos Actions
- Relacionamentos Actions
- Metadata Actions
Entidades → Ler todos registros
AI-generatedSummary
Read all records of a specified entity from EspoCRM, supporting optional filtering, sorting, pagination, and attribute selection.
Inputs
- Entidade (required) — The specific entity to read records from.
- Opções — Optional parameters including disabling total calculation for better performance, returning all records with automatic pagination, limiting max size (up to 200), applying offset, ordering by a field and order direction, applying primary and boolean filters, a text filter, selecting specific attributes to retrieve, and providing complex where group filters in JSON.
Output shape
a JSON object containing a list of matching records, and optionally a total count; or a list of individual record items when 'Retornar lista como itens' is enabled.
The operation supports automatic pagination if 'Retornar tudo' is enabled, fetching all records up to the max size limit. Responses include a 'list' array and 'total' count unless 'extractListItems' is enabled, in which case each record is returned individually as an item. Filters and attribute selection are applied via query string parameters to the EspoCRM API.
Examples
Example 1: Get all records from the 'Account' entity, returning up to 100 records sorted by 'name' in ascending order.
Set 'Entidade' to 'Account', 'Opções.Tamanho Máx.' to 100, 'Opções.Ordenar por' to 'name', and 'Opções.Ordem' to 'asc'.