Pagination

Each API can be configured with full pagination, supporting all standard pagination methods.

These settings exist on the right-hand side of the Properties tab of any REST API.

Limit

The limit section is where you define:

• Location: This parameter defines where the limit on results will be set: as a query param, in the body, or as a parameter in the request.

• Key: This is the key that will be used when passing the limit. This must comply with MindCloud standards and be camel case.

• External Key: If the application requires a key in a format that doesn’t comply with MindCloud standards, you can use this field to set the key in whatever format required.

• Default Limit: This is the default limit for any action that uses this API, so long as pagination is enable.

• Min Limit: This is the minimum limit that can be set at the action level.

• Max Limit: This is the maximum limit that can be set at the action level.

Offset

Offset is where you define the methodology to offset multiple pages, using the following fields:

• Location: This parameter defines where the the current offset value will be passed in the API call (query param, body, or parameter in the request).

• Type: This is where you define which pagination type will be used.

• Key: This is the key that will be used when passing the current offset value. This must comply with MindCloud standards and be camel case.

• External Key: If the application requires a key in a format that doesn’t comply with MindCloud standards, you can use this field to set the key in whatever format required.

Pagination Types

Offset Pagination:

• Limit = 20, offset = 0 -> records 0 through 20

• Limit = 20, offset = 20 -> records 20 through 40

Page Number Pagination:

• Limit = 20, page = 1 -> records 0 through 20

• Limit = 20, page = 2 -> records 20 through 40

Cursor Pagination:

See cursor pagination.

Range Pagination:

• Limit = 20, page = 40 -> records 20 through 40