Skip to main content

Pages

This section covers the endpoints for retrieving static page content.

Available Endpoints

Get Page Content

Retrieve content for a specific static page by its key.

Endpoint

  • Method: GET
  • URL: /v1/customer/pages/{key}

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes

Path Parameters

ParameterTypeDescriptionRequired
keystringUnique identifier for the page (e.g., 'about', 'terms', 'privacy')Yes

Success Response

{
"success": true,
"message": "تم جلب البيانات بنجاح",
"data": {
"id": "uuid",
"key": "string",
"title": "string",
"description": "string",
"kry": "string",
"type": "string",
"link": "https://image",
"priority": 100,
"canModified": true,
"loggedInOnly": true,
"isActive": true,
"updatedAt": "Sep-2024"
},
"statusCode": 200
}

Error Response

Page Not Found (404)
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}

Overview

Available Page Keys

  • about: About Us page
  • terms: Terms and Conditions
  • privacy: Privacy Policy
  • faq: Frequently Asked Questions
  • contact: Contact Information
  • help: Help Center

Important Notes

  • All page content is returned in HTML format
  • Pages are cached for better performance
  • Content is managed through the admin panel
  • Pages support both Arabic and English content
  • Content can include images and formatted text
  • Pages are version controlled
  • Content updates are tracked with timestamps