Interface PagingInterface

Pagination interface for list responses

Used by API endpoints that return paginated lists of resources. Supports both offset-based and page-based pagination.

Example

const paging: PagingInterface = {
  offset: 20,
  limit: 10,
  total: 100,
  page: 3,
  total_pages: 10
};
interface PagingInterface {
    offset?: number;
    limit?: number;
    total?: number;
    page?: number;
    total_pages?: number;
}

Properties

offset? limit? total? page? total_pages?

Properties

Optionaloffset

offset?: number

Number of items to skip (for offset-based pagination)

Optionallimit

limit?: number

Maximum number of items to return

Optionaltotal

total?: number

Total number of items available

Optionalpage

page?: number

Current page number (for page-based pagination)

Optionaltotal_pages

total_pages?: number

Total number of pages available

Settings

Member Visibility

On This Page

Properties