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
| Parameter | Type | Default | Description |
|---|---|---|---|
| limit | integer | 10 | Number of results per page |
| offset | integer | 0 | Number of results to skip |
| ordering | string | -created_at | Sort order (`id`, `title`, `slug`, `created_at`, `updated_at`) |
| search | string | — | Search in (`id`, `title`, `slug`, `meta__key`, `meta__value_text`) |
| id_min | integer | — | Minimum ID filter |
| id_max | integer | — | Maximum ID filter |
| created_date | string | — | Filter by creation date (e.g., 2023-01-01) |
| updated_date | string | — | Filter by last updated date (e.g., 2023-01-01) |
| created_from | string | — | Filter by creation date range start |
| created_to | string | — | Filter by creation date range end |
| updated_from | string | — | Filter by last updated date range start |
| updated_to | string | — | Filter by last updated date range end |
| has_body | boolean | _ | Whether the page has a value for body |
Example Requests
- 🐍 Python
- 🌐 Curl
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())1# List all pages
2curl "http://www.example.com/api/pages" \
3-H "Authorization: Token <your_api_key>"
4
5# List all pages that have a value for body
6curl "http://www.example.com/api/pages?has_body=true" \
7-H "Authorization: Token <your_api_key>"Response Fields
| Field | Type | Description |
|---|---|---|
| count | Integer | Total number of categories |
| next | String | URL for the next page of results |
| previous | String | URL for the previous page of results |
| results | Array[Object] | Array of Page objects |
Page Object Structure
| Field | Type | Description |
|---|---|---|
| id | Integer | Id of the page(unique) |
| title | String | The title of the page |
| slug | String | The slug related to the page (unique) |
| created_at | String (ISO 8601) | Timestamp when the page was created |
| updated_at | String (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