Interface ListParams

Common pagination query parameters accepted by list endpoints.

interface ListParams {
    cursor?: string;
    page?: number;
    perPage?: number;
}

Index

Properties

cursor? page? perPage?

Properties

`Optional`cursor

cursor?: string

Opaque cursor from a previous Page.nextCursor. Overrides page/perPage.

`Optional`page

page?: number

1-based page number. Defaults server-side to 1.

`Optional`perPage

perPage?: number

Items per page. Server default is 10 or 20 depending on the resource.