Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 2.0!

Throtteling

The API is limited to return 1.000 record at a time when providing list of records. To page the results, please use the following parameters.

Option

Description

$top

Returns only the first n the results.

$skip

Skips the first n results.

$select

Selects which properties to include in the response.

$orderby

Sorts the results.

$expand

Expands related entities inline. These are arrays of objects and object properties.

$filter

Filters the output.

Read more here. Examples here.

To page a result set, use the parameters. The following example will skip the first 10 results, and take a list of 50.

GET /customers/?$skip=10&top=50 HTTP/1.1

🚧

Only list methods support paging

Example /customers/ will support paging, where-as single results like /customers/{id}/ will not.

https://api.upodi.io/v2/customers/?$select=ID,Subscriptions/ID&$expand=Subscriptions