Get all holdings

This endpoint returns every holding in the firm that the authenticated account is permitted to see. Employees see holdings on the plans they can read (all plans with plans:readAll, otherwise the plans owned by clients in their groups). Clients see holdings on their own plans that are visible on the client portal.

Iterating the full dataset. Holdings is the largest dataset in a firm and can run to millions of rows. When paging through the whole set you must use cursor pagination by sending the X-PLANNR-CURSOR-PAGINATION: true header. Each page then costs the same regardless of how deep you are, whereas page based pagination gets slower the further you go. In cursor mode the response does not include meta.total or meta.last_page; follow links.next (or meta.next_cursor) until it is null. For incremental syncs, use filter[updated_at] to fetch only holdings changed since your last run.

Holdings in proposed portfolios are excluded. Only active holdings are returned unless filter[is_active] is set.