hubspot-api-python: paginating associations with `batch_api.read` silently loops forever

TL;DR

Passing after is silently ignored because the BatchInputPublicObjectId model has no after field, which is exactly what causes the infinite loop you are seeing. The maintained answer: switch to the v4 associations API, api\client.crm.associations.v4.basic\api.get\_page(...), which supports after, limit, and real paging. If it does, work through the verified fix step by step.

When to use

You are seeing this: I am trying to pull more than 100 results from associations.batch\api.read in hubspot-api-python. Use this skill when you run into "hubspot-api-python: paginating associations with `batchapi.read` silently loops forever".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

No specific versions are mentioned in the source material, so treat the fix as generally applicable and check the examples against whatever you have installed.

What's going on

I am trying to pull more than 100 results from associations.batch_api.read in hubspot-api-python. The function does not seem to support pagination: the API response has no paging key I can use, and when I try passing an after cursor like BatchInputPublicObjectId(inputs=[{'id': from_object_id, 'after': after}]) it silently returns the same page, which puts my loop into an infinite cycle. How do I actually paginate associations?

The verified fix

The v3 associations.batch_api.read does not support pagination at all. Passing after is silently ignored because the BatchInputPublicObjectId model has no after field, which is exactly what causes the infinite loop you are seeing. The maintained answer: switch to the v4 associations API, api_client.crm.associations.v4.basic_api.get_page(...), which supports after, limit, and real paging. One quirk to know: in v4 the paging key is only present in the response when there are more pages, so absence of paging means you are on the last page.

How to use this

Take the question above and check if it matches what you're seeing. If it does, work through the verified fix step by step. Start with the cause described first, because that's what tells you the fix applies to your setup, then apply the changes in the order given. Verify by re-running whatever failed before, and expect the same behavior the thread author reported.

Someone asked: I am trying to pull more than 100 results from associations.batch_api.read in hubspot-api-python. The function does not seem to support pagination: the API response has no paging key I can use, and when I try passing an after cursor like BatchInputPublicObjectId(inputs=[{'id': from_object_id, 'after': after}]) it silently returns the same page, which puts my loop into an infinite cycle. How do I actually paginate associations? The verified answer: The v3 associations.batch_api.read does not support pagination at all. Passing after is silently ignored because the BatchInputPublicObjectId model has no after field, which is exactly what causes the infinite loop you are seeing. The maintained answer: switch to the v4 associations API, api_client.crm.associations.v4.basic_api.get_page(...), which supports after, limit, and real paging. One quirk to know: in v4 the paging key is only present in the response when there are more pages, so absence of paging means you are on the last page.

Source: https://github.com/HubSpot/hubspot-api-python/issues/187 Discussion and confirmation live at https://vectle.com/threads/thr_yUremUPhWaOLD5WSRDctsA