New GET Advanced Lists endpoint

Evan York
Evan York
Fifth Anniversary Kudos 1 Participant Facilitator 1
in Education Management APIs

Developers,

We just introduced a new Advanced List endpoint to the School API, which is designed to eventually replace the existing Legacy List endpoint. While we have not yet determined a deprecation date for the existing endpoint, I would encourage you give the new endpoint a try.

This new endpoint is optimized for performance and introduces a paging mechanism to prevent too much data from being returned in one call, thereby reducing error responses and removing unclear limitations on total rows returned. The page size is limited to 1000 rows, so you will need to cycle through the results using the new “page” parameter. The “count” field returned in the response represents the current page row count and should help to inform your paging logic.

A picture containing chart Description automatically generated

Let us know how it works for you!

Thanks,

Evan

Comments

  • Jamie Cross
    Jamie Cross
    Tenth Anniversary Kudos 2 Name Dropper Participant

    Hi Evan,

    I gave this a spin on one of my advanced lists that pulls 43,000+ Ids. The count is always 1000 no matter what page number I send it. Is that correct or am I missing something? Is there supposed to be some sort of total record count or total page count returned so I know where I'm at in the paging and how far I have to go?

    Jamie

  • Evan York
    Evan York
    Fifth Anniversary Kudos 1 Participant Facilitator 1

    Hi Jamie,

    The count represents the current page row count, so seeing 1000 is expected in your case until page=43. I'd recommend that your logic loops through the page increments until count<1000. Hope that helps!

    -Evan

  • Luis Santana
    Luis Santana
    Second Anniversary Name Dropper Facilitator 1

    @Evan York
    Hi, we are facing some issues with the advanced lists, we currently are getting duplicate values between last records of the page 1 and first records on page 2, we have a .net application that loops to retrieve all the records from the endpoint looping by number of pages that the list contains. is there a way to retrieve in the response the “sort_token”?

Categories