EspoCRM Tool icon

EspoCRM Tool

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

Actions14

Relacionamentos → Listar relacionados

AI-generated

Summary

List related records for a given entity record via a specified relationship link in EspoCRM.

Inputs

  • entity (required) — The EspoCRM entity (module) from which to list related records.
  • recordIdRelationship (required) — The ID of the record in the selected entity to find related records for.
  • relationshipLinkField (required) — The relationship link field name defining which related records to retrieve.
  • options — Optional filters and pagination to refine the list of related records, including offset, limit (maxSize), ordering, primary filters, boolean filters, text filters, attribute selection, and whereGroup for advanced queries.

Output shape

a JSON object representing the list of related records, including a 'list' array of records and a 'total' count.

Supports pagination and optionally can return all records automatically by paginating through results. Can output either the full response object or just the individual related records as separate items depending on the options.

Links

Discussion