Skip to main content

List PageMetas for a specific page

Retrieves a list of all page meta data for a specific page

HTTP Request​

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

Authorization​

Authorization

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

Path Parameters​

ParameterTypeRequiredDescription
page_idIntegerYesUnique ID of the page

Query Parameters​

ParameterTypeDefaultDescription
limitinteger10Number of results per page
offsetinteger0Number of results to skip
orderingstring-created_atSort order (`id`, `key`, `value_text`, `created_at`, `updated_at`)
searchstring—Search in (`key`, `value_text`, `value_file__name`)
id_mininteger—Minimum ID filter
id_maxinteger—Maximum ID filter
created_datestring—Filter by creation date (e.g., 2023-01-01)
updated_datestring—Filter by last updated date (e.g., 2023-01-01)
created_fromstring—Filter by creation date range start
created_tostring—Filter by creation date range end
updated_fromstring—Filter by last updated date range start
updated_tostring—Filter by last updated date range end
has_value_textboolean_Filters meta with a text value
has_value_fileboolean_Filters meta with a file value

Example Requests​

1import requests
2
3# List Meta for a page
4response = requests.get('http://www.example.com/api/pages/base/38/meta',
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())
8
9# List all meta for a page with text value
10response = requests.get('http://www.example.com/api/pages/base/38/meta', params={
11  'has_value_text': 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 PageMeta objects

PageMeta Object Structure​

FieldTypeDescription
idIntegerId of the meta(unique)
keyStringThe key name of the meta
value_textStringThe text value related to the key (nullable)
value_file_dataobjectThe file value related to the key (nullable)
created_atString (ISO 8601)Timestamp when the page was created
updated_atString (ISO 8601)Timestamp when the page was last updated

Value File Structure

FieldTypeDescription
idIntegerId of the file (unique)
typeStringType of the file (image, text, video, ...)
mime_typeStringMime type of the File (e.g., image/jpeg) (nullable)
nameStringFile name (nullable)
sizeStringSize of the file(nullable)
human_readable_sizeStringA human readable size for the file
fStringurl to the file

Example Response​

{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": 8,
"key": "text_about_us",
"value_text": "this is all about us",
"value_file_data": null,
"created_at": "2025-12-03T14:41:19.070933Z",
"updated_at": "2025-12-03T14:41:19.070937Z"
},
{
"id": 7,
"key": "image_bottom",
"value_text": "",
"value_file_data": {
"id": 2,
"type": "image",
"mime_type": "image/jpeg",
"name": "logitech-mx-1",
"size": 4766,
"human_readable_size": "4.65 KB",
"f": "http://127.0.0.1:8000/media/core_media/2025/11/22/logitech-mx-1.jpg"
},
"created_at": "2025-12-03T14:41:19.069145Z",
"updated_at": "2025-12-03T14:41:19.069149Z"
},
{
"id": 1,
"key": "image_top",
"value_text": "",
"value_file_data": {
"id": 1,
"type": "image",
"mime_type": "image/png",
"name": "logitech-logo",
"size": 2763,
"human_readable_size": "2.70 KB",
"f": "http://127.0.0.1:8000/media/core_media/2025/11/22/logitech.png"
},
"created_at": "2025-11-23T10:18:36.325053Z",
"updated_at": "2025-12-03T14:40:53.987756Z"
}
]
}

NOTES​

  • A meta is only allowed to have either a text or file as the value (not both not none)