List records
beaconcrm_list_recordsRead-only
List records of one type (for example person, organization, payment), one page at a time. Use beaconcrm_filter_records to search by field values. GET /entities/{entity}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| entity | Yes | Record type key, e.g. person, organization, payment or a custom type such as c_application. See beaconcrm_list_record_types. | |
| sort_by | No | Field key to sort by, e.g. created_at. | |
| archived | No | true = list deleted (archived) records instead of active ones. | |
| per_page | No | Results per page, 1-100 (default 25). | |
| populate | No | Include data from linked records (point-to-another-record fields). Beacon's default applies when omitted. | |
| sort_direction | No | Sort direction (default: Beacon's default order). |