Pagination - Good Grants

Our APIs support offset-based pagination with the query parameter ?page=1. Use ?per_page= to control the number of records returned per page (between 1 and 100, default 10).

# Get the first page with 5 results per page
curl "https://api.us.cr4ce.com/user?page=1&per_page=5"

# Get the next page
curl "https://api.us.cr4ce.com/user?page=2&per_page=5"

Paginated resource responses contain a specific set of pagination helper links in the top-level object. Use these links to navigate to different pages of data.

Response

{
  "current_page": 1,
  "data": [],
  "first_page_url": "https://api.us.cr4ce.com/user?page=1&per_page=5",
  "from": 1,
  "last_page": 10,
  "last_page_url": "https://api.us.cr4ce.com/user?page=10&per_page=5",
  "next_page_url": "https://api.us.cr4ce.com/user?page=2&per_page=5",
  "path": "https://api.us.cr4ce.com/user",
  "per_page": 5,
  "prev_page_url": "",
  "to": 10,
  "total": 200
}

Paginated results

Paginated responses usually include the following fields:

integer

Number of the page returned by this response. The first page is 1.

array

Array containing resource information.

string

URL of the first page in the result set. Relative when the requested page is beyond the last page.

integer | null

Position of the first record on this page within the full result set. The first record is at position 1. null when the requested page is beyond the last page.

integer

Number of the last page. Equals the total number of pages.

string

URL of the last page in the result set. Relative when the requested page is beyond the last page.

string | null

URL of the next page in the result set. Empty string when the current page is the last page.

string

Canonical URL of the endpoint, without query parameters.

integer

Maximum number of records returned per page.

string | null

URL of the previous page in the result set. Empty string when the current page is the first page.

integer | null

Position of the last record on this page within the full result set. null when the requested page is beyond the last page.

integer

Total number of records across all pages.

​Paginated results

Paginated results