Skip to Content
API ReferencePages API

Pages API

Endpoints for managing pages in the system.

Get Pages List

Get the complete list of pages.

Request

GET /api/flute-pages

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "pages": [ { "id": 1, "title": "Home Page", "slug": "home", "is_active": true, "created_at": "2023-01-01T00:00:00Z" }, { "id": 2, "title": "About Us", "slug": "about", "is_active": true, "created_at": "2023-01-02T00:00:00Z" } ] }

Response Fields

FieldTypeDescription
pagesarrayArray of pages
idintegerPage ID
titlestringPage title
slugstringURL-compatible identifier
is_activebooleanPage active status
created_atstringCreation date

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request

Get Page Data

Get detailed information about a specific page.

Request

GET /api/flute-pages/{id}

Path Parameters

NameTypeDescription
idintegerPage ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "page": { "id": 1, "title": "Home Page", "slug": "home", "content": "<h1>Welcome!</h1><p>This is our website's home page.</p>", "meta_title": "Home - Our Site", "meta_description": "Home page of our project", "is_active": true, "created_at": "2023-01-01T00:00:00Z", "updated_at": "2023-01-10T00:00:00Z" } }

Response Fields

FieldTypeDescription
pageobjectPage object
idintegerPage ID
titlestringPage title
slugstringURL-compatible identifier
contentstringHTML page content
meta_titlestringMETA title for SEO
meta_descriptionstringMETA description for SEO
is_activebooleanPage active status
created_atstringCreation date
updated_atstringUpdate date

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request
404Page not found

Create Page

Create a new page in the system.

Request

POST /api/flute-pages

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "title": "New Page", "slug": "new-page", "content": "<h1>New Page</h1><p>New page content.</p>", "meta_title": "New Page - Our Site", "meta_description": "New page description", "is_active": true }

Request Body Parameters

NameTypeDescription
titlestringRequired. Page title
slugstringRequired. URL identifier
contentstringRequired. HTML content
meta_titlestringOptional. META title
meta_descriptionstringOptional. META description
is_activebooleanOptional. Active status

Response

{ "message": "Page created successfully", "page": { "id": 3, "title": "New Page", "slug": "new-page", "content": "<h1>New Page</h1><p>New page content.</p>", "meta_title": "New Page - Our Site", "meta_description": "New page description", "is_active": true, "created_at": "2023-03-15T12:00:00Z" } }

Response Codes

CodeDescription
201Page successfully created
401Invalid or missing API key
403Insufficient permissions to perform request
422Invalid request parameters

Update Page

Update data of an existing page.

Request

PUT /api/flute-pages/{id}

Path Parameters

NameTypeDescription
idintegerPage ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "title": "Updated Page", "content": "<h1>Updated Page</h1><p>Updated page content.</p>", "meta_title": "Updated Page - Our Site", "meta_description": "Updated page description", "is_active": true }

Request Body Parameters

NameTypeDescription
titlestringOptional. Page title
slugstringOptional. URL identifier
contentstringOptional. HTML content
meta_titlestringOptional. META title
meta_descriptionstringOptional. META description
is_activebooleanOptional. Active status

Response

{ "message": "Page updated successfully", "page": { "id": 3, "title": "Updated Page", "slug": "new-page", "content": "<h1>Updated Page</h1><p>Updated page content.</p>", "meta_title": "Updated Page - Our Site", "meta_description": "Updated page description", "is_active": true, "updated_at": "2023-03-16T14:30:00Z" } }

Response Codes

CodeDescription
200Page successfully updated
401Invalid or missing API key
403Insufficient permissions to perform request
404Page not found
422Invalid request parameters

Delete Page

Delete a page from the system.

Request

DELETE /api/flute-pages/{id}

Path Parameters

NameTypeDescription
idintegerPage ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "message": "Page deleted successfully" }

Response Codes

CodeDescription
200Page successfully deleted
401Invalid or missing API key
403Insufficient permissions to perform request
404Page not found

Get Page Blocks

Get the list of blocks attached to a page.

Request

GET /api/flute-pages/{id}/blocks

Path Parameters

NameTypeDescription
idintegerPage ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "blocks": [ { "id": 1, "type": "text", "content": "<p>This is the first text block</p>", "order": 1 }, { "id": 2, "type": "image", "content": { "url": "/uploads/image.jpg", "alt": "Image", "width": 800, "height": 600 }, "order": 2 } ] }

Response Fields

FieldTypeDescription
blocksarrayArray of blocks
idintegerBlock ID
typestringBlock type (text, image, etc)
contentmixedBlock content
orderintegerDisplay order

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request
404Page not found