Skip to main content

List Pages

API operation: Open the endpoint in Scalar

Use GET /pages to list project pages. The current public operation is Page.findAll.

Unauthenticated callers receive only pages marked both enabled and public. Authenticated non-administrators can list enabled pages; administrators can list pages regardless of those flags.

See Pages model.

OpenAPI reference​

Operation: GET /pages

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
orderBystringNoField to sort by, with - prefixed for descending order. Multiple fields can be chained with commas.
wherestringNoJSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension.
pageintegerNoPage number, starting at 1. Applies only to lists that return a pagination block.
page_sizeintegerNoNumber of items per page.

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized (ProjectAccessErrorResponse)
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference