Paging Parameters

Overview

For GET requests responses may be returned in groups.

Custom group sizes

It is possible to customize the paging parameters for each query. If you want to customize the settings, include the following object in your request:

{
  "group_size": <integer>
}

This will return groups of the specified size. Please note the following rules:

• If not specified, the group size will be 25;
• The group size is limited to a maximum of 25;
• The group size is limited to a minimum of 1;
• If a number outside this range is specified the default will apply;

Specifying the custom group sizes

To set the group size parameters include the object in your request:

[
  {
    "paging": {
      "group_size": 20
    },
    "account_id": "<string>",
    "website_id": "<string>",
    "ids": [
      "<string>"
    ]
  }
]

Sorting

At this time the API sorts all results in descending order on the creation date so the most recent record is first in the results.