Aeries REST API: paginated retrieval on the Contacts endpoint for high-volume districts
The Aeries REST API returns correct data, but the Contacts endpoint returns every contact record for a school in a single response. Because the API works as designed, this is an enhancement request rather than a defect.
What is happening now: At high-volume districts, a single large school can return tens of thousands of contact records in one response, which strains memory and slows third-party synchronization.
What would help: Allow the Contacts endpoint to accept StartingRecord and EndingRecord parameters, the same way the Students endpoint already does, so callers can retrieve contacts in bounded ranges instead of one oversized response. Requests without these parameters would continue to return all records exactly as they do today.
Impact if unchanged: High-volume districts continue to pull oversized Contacts responses, with slower syncs and higher failure risk as enrollment grows.
AdminJuan Alberto
(Senior Business Analyst, Aeries Software)
shared this idea
Hello, this work item has been completed and was released on 8/4/26. Here are the relevant revision notes:
- Aeries API > Contacts: The /contacts endpoint now supports StartingRecord and EndingRecord parameters, so large schools' contact records can be retrieved in paginated ranges. Requests without these parameters continue to return all records as before. See Aeries API - Student-related end points > Contacts.
