Sign up

Lists

Get one page of a list, or every item in it.

A list method returns a Page. Read its items for one page, or loop over it for every item: it asks for the next page as you go.

One page

page = goomzo.customers.list(limit=50)

page.items  # up to 50 customers
page.next_cursor  # None on the last page
page.total  # how many match, on every page

Every item

for customer in goomzo.customers.list(limit=200):
    sync_customer(customer)

With asyncio, await a list for one page, or async for over it for every item:

page = await goomzo.customers.list(limit=50)

async for customer in goomzo.customers.list(limit=200):
    await sync_customer(customer)

Note: limit sets the size of each page, up to 200. A larger page means fewer requests.

Next steps

Last updated