Paginated List

A representation of a paginated list of entries.

Our API uses cursor-based pagination to represent collections of items with variable length (such as the Scheduling Links list endpoint).

The metadata object contains before and after cursors that you can use to traverse collections forward and backward. If there are no entries in the collection before the given set, the before cursor will be null . Similarly, if there are no entries in the collection after the given set, the after cursor will be null .

Pagination cursors are opaque; they do not represent stable identifiers for resources, so you shouldn't attempt to decode them to use for long-term storage.

Properties

This resource includes the following properties:

Property

Type

Description

entries

array

An array of resource objects.

metadata

object

An object containing pagination metadata.

before

string | null

A cursor for fetching entries before the first item in the entries list.

after

string | null

A cursor for fetching entries after the first item in the entries list.

limit

integer

The maximum number of entries returned.

Example

Here is an example representation of this resource:

{
"entries": [
{ "id": 1 },
{ "id": 2 }
],
"metadata": {
"before": null,
"after": "g3QAAAABZAACaWRiAAAbFA==",
"limit": 2
}
}