Pagination

Our API endpoints support pagination to retrieve projects in chunks. This allows for efficient data retrieval, especially when dealing with a large number of projects.

Request Parameters

page (optional): Specifies the page number to retrieve. Defaults to 1 if not provided.

limit (optional): Specifies the number of projects to retrieve per page. Defaults to 10 if not provided.

Usage

To retrieve the second page of the projects:

GET /api/v1/projects?page=2

To retrieve the third page of the projects with a limit of 5 projects per page:

GET /api/v1/projects?page=3&limit=5

Constraints

  • The page value must be greater than 0. If an invalid page value is provided, an error response will be returned. see pagination errors for more details.

  • The limit value must be greater than 0 and less than or equal to 20. If an invalid limit value is provided, an error response will be returned. see pagination errors for more details.

Skip Parameter

The API handles the skip parameter internally. It calculates the number of projects to skip based on the provided page and limit values.

Response

The response will include the projects for the specified page and limit, along with metadata such as the total number of projects, current page, limit, and total pages.

Last updated