Skip to main content

List Pages

Retrieves a list of pages

HTTP Request

GET/api/pages/
NOTE: NOT USING THE TRAILING SLASH AT THE END OF THE URL RESULTS TO AN INTERNAL REDIRECT

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with PagePermission or Admin
  • Permission Code: 3002
  • Authentication: Token-based (Authorization: Token <your_api_key>)

Query Parameters

ParameterTypeDefaultDescription
limitinteger10Number of results per page
offsetinteger0Number of results to skip
orderingstring-created_atSort order (`id`, `title`, `slug`, `created_at`, `updated_at`)
searchstringSearch in (`id`, `title`, `slug`, `meta__key`, `meta__value_text`)
id_minintegerMinimum ID filter
id_maxintegerMaximum ID filter
created_datestringFilter by creation date (e.g., 2023-01-01)
updated_datestringFilter by last updated date (e.g., 2023-01-01)
created_fromstringFilter by creation date range start
created_tostringFilter by creation date range end
updated_fromstringFilter by last updated date range start
updated_tostringFilter by last updated date range end
has_bodyboolean_Whether the page has a value for body

Example Requests

1import requests
2
3# List Pages
4response = requests.get('http://www.example.com/api/pages',
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())
8
9# List all pages with body
10response = requests.get('http://www.example.com/api/pages', params={
11  'has_body': True,
12}, headers={'Authorization': 'Token <your_api_key>'})
13print(response.json())

Response Fields

FieldTypeDescription
countIntegerTotal number of categories
nextStringURL for the next page of results
previousStringURL for the previous page of results
resultsArray[Object]Array of Page objects

Page Object Structure

FieldTypeDescription
idIntegerId of the page(unique)
titleStringThe title of the page
slugStringThe slug related to the page (unique)
created_atString (ISO 8601)Timestamp when the page was created
updated_atString (ISO 8601)Timestamp when the page was last updated

Example Response

{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 45,
"title": "‘Security Disaster’—500 Million Microsoft Users Say No To Windows 11",
"slug": "security-disaster-500-million-microsoft-users-say-no-to-windows-11",
"created_at": "2025-12-02T18:11:46.461502Z",
"updated_at": "2025-12-02T18:11:46.461509Z"
},
{
"id": 38,
"title": "The Most Powerfull Processor Is Here",
"slug": "the-most-powerfull-processor-is-here",
"created_at": "2025-11-23T10:13:21.776387Z",
"updated_at": "2025-11-23T10:13:21.776392Z"
}
]
}

NOTES

  • Not including the trailing slash '/' at the end of the url results to an internal redirect