Pagination

Many resources provide pagination options. Read below to learn more about the pagination object structure.

`links` Properties

  • Name
    first
    Type
    string
    Description

    The URL of the first page in this result set

  • Name
    last
    Type
    string
    Description

    The URL of the last page in this result set.

  • Name
    prev
    Type
    string
    Description

    The URL of the previous page (or null)

  • Name
    next
    Type
    string
    Description

    The URL to the next page in this result set (or null).

`meta` Properties

  • Name
    current_page
    Type
    int
    Description

    The current page number

  • Name
    from
    Type
    int
    Description

    The index of the first record.

  • Name
    to
    Type
    int
    Description

    The index of the last record on this page

  • Name
    per_page
    Type
    int
    Description

    The number of records per page

  • Name
    total
    Type
    int
    Description

    The total number of records available

  • Name
    path
    Type
    string
    Description

    The URL of the current resource

  • Name
    last_page
    Type
    int
    Description

    The number of the last page in this result set

  • Name
    links
    Type
    array
    Description

    An array of links for building pagination on in HTML