Pagination

Pagination is supported across most list endpoints so that large result sets can be batched into multiple responses. The maximum page size is 2000 results per response.

Supported endpoints

Category	Endpoints
Ownership	Entities, Entity Types, Groups, Group Types, Positions, External ID Types
Portfolio	Arguments, Attributes, Benchmarks, Benchmark Associations, Benchmark Compositions, Benchmark Proxies, Constituent Attributes, Derivatives (Underlying Assets, Yield Curves), Estimated Returns, Portfolio Views
Transactions	Jobs, Transaction Jobs
Billing	Fees, Fee Schedules, Billable Portfolios, Billing Payout (Recipients, Rules)
Admin	Users, Teams, Contacts, Files, Archived Files, Generated Reports, Reports, View Sets, Report Schedule
Allocations	Allocation Models, Allocation Templates

Query parameters

Parameter	Description
`page[limit]`	Integer -- Number of results per page. Maximum: `2000`. Default: `500`. Example: `100`
`page[after]`	Integer -- Cursor for the next page. The response starts immediately after this ID. Example: `10001`

Response links

Every paginated response includes a links object:

Field	Description
`links.next`	String -- URL for the next page of results. `null` if no additional pages exist.

Example

curl -X GET "https://{firm}.addepar.com/api/v1/entities?page[limit]=100" \
  -H "Authorization: Basic {credentials}" \
  -H "Addepar-Firm: 1" \
  -H "Accept: application/vnd.api+json"

HTTP/1.1 200

{
  "data": [
    ...
  ],
  "links": {
    "next": "/v1/entities?page[limit]=100&page[after]=10001"
  }
}

📘
Pagination flow

Make your initial request with an optional page[limit].

Check links.next in the response.

If non-null, request that URL to get the next page.

Repeat until links.next is null.

Supported endpoints

Query parameters

Response links

Example

Pagination flow

What’s Next