Read from Populi
populi_getRetrieve read-only data from any Populi API v2 route using filters, pagination, and related-record expansion for people, academics, admissions, and billing records.
Instructions
GET any Populi API v2 route (read-only). Path is under /api2, e.g. /people/123, /academicterms, /people/123/leads. Lists return up to 200 records per page; use page, limit, or all_pages. Use expand to inline related records (see populi_describe_api for the allowed names) and filter to narrow lists. A filter looks like {"0":{"logic":"ALL","fields":[{"name":"first_name","value":{"type":"CONTAINS","text":"john"},"positive":1}]}}. Populi allows about 50 requests/min per key, so prefer one filtered call over many unfiltered ones. Routes that return a file (PDF/XLS exports, transcripts, Data Slicer results, file downloads) can't be shown here: use populi_download for those. If a rate limit stops all_pages part-way, the pages already fetched are returned with a next_page to resume from.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page of results, 1-based. With all_pages, the page to start from | |
| path | Yes | Route under /api2, with real ids, e.g. /people/24469940/leads | |
| limit | No | Records per page | |
| expand | No | Related properties to include | |
| filter | No | Populi filter object (list routes) | |
| params | No | Any other documented parameters for the route (sort, report options, format, ...) | |
| all_pages | No | Follow pagination and merge every page into one list | |
| max_chars | No | Truncate the response text beyond this many characters | |
| timeout_ms | No | Per-request timeout. Raise for slow reports and exports (default 120000) | |
| max_records | No | With all_pages: stop once at least this many records are collected (the last page is kept whole). The result says whether it finished and, if not, the next_page to continue from |