Actions14
- Entidades Actions
- Documentos Actions
- Relacionamentos Actions
- Metadata Actions
Relacionamentos → Listar relacionados
AI-generatedSummary
Retrieve a list of records related to a specified record via a defined relationship link within a chosen EspoCRM entity.
Inputs
- entity (required) — The EspoCRM entity name to query within.
- recordIdRelationship (required) — The ID of the record to find related records for.
- relationshipLinkField (required) — The name of the relationship link field defining the related records to list.
- options — Collection of optional parameters to control pagination, filtering, ordering, attribute selection, and result format.
Output shape
A JSON object containing a list of related records along with optional metadata such as total count.
Supports pagination and filtering. If 'returnAll' is set, it will automatically paginate to retrieve all related records. The output can be returned either as a single object containing 'list' and 'total' properties or as multiple individual items when 'extractListItems' is enabled.
