Skip to main content
GET
/
pages
List all content pages
curl --request GET \
  --url http://localhost:3001/portal-api/pages \
  --header 'Authorization: <api-key>'
[
  {
    "AllowFormSubmission": false,
    "PageTypeID": 123,
    "Path": "/about-us",
    "Status": "/about-us",
    "Template": "home",
    "Title": "About Tyk Portal",
    "ID": 1
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
AllowFormSubmission
boolean

dsf

Example:

false

​
PageTypeID
integer
​
Path
string

Path to this page

Example:

"/about-us"

​
Status
string

Path to this page

Example:

"/about-us"

​
Template
string

Name of templates that is used by this page. Value of this property must match one of template names in theme.json

Example:

"home"

​
Title
string

Title of the page

Example:

"About Tyk Portal"

​
ID
integer

UID of this page

Example:

1