Headless CMS Admin API Documentation

Welcome to the Typeflo Headless CMS Admin API documentation. This API allows you to create, modify & delete the content such as posts, categories, tags from your Typeflo-powered blog programmatically.

Authentication

To use the Typeflo's Admin API, you need a Admin API key.

Retrieving Your API Key

1. Log in to your Typeflo admin dashboard.

2. Navigate to Settings > Apps.

3. Under Manage Custom Apps , click on +Add

4. Create new custom app with the name of your choice

5. Once created, head over to the newely created app settings to view the API Keys

6. From the Settings page, you will be able to get the below credentials:-

   1. Content & Admin API keys

   2. Content & Admin API URLs

Securing Your Admin API Key

The Admin API key is a powerful credential that grants access to your Typeflo Headless CMS Admin API. Proper security measures must be taken to protect your API key and prevent unauthorized access to your Typeflo-powered blog.

Why Securing the Admin API Key Is Important

The Admin API key provides full control over your content, including creating, modifying, and deleting posts, categories, and tags. If this key is exposed, malicious actors can gain access to your blog, potentially causing data breaches, content manipulation, or service disruptions.

Base URL

GET https://<your-subdomain>.typeflo.io/api/headless/admin

Usage

To authenticate requests, pass the Admin API key as a bearer token in the Authorization header.

For example:

GET https://<your-subdomain>.typeflo.io/api/headless/admin/posts
Authorization: Bearer YOUR_ADMIN_API_KEY

Endpoints

The Typeflo Admin API provides endpoints for:

• Posts

• Categories

• Tags

1. Posts

Publish, Schedule, Update & Delete the posts created in your blog

Endpoints

POST /posts
PATCH /posts/{id}
DELETE /posts/{id}

Example Request

POST https://<your-subdomain>.typeflo.io/api/headless/admin/posts
Authorization: Bearer YOUR_ADMIN_API_KEY
Content-Type: application/json

{
  "title": "Sample Post",
  "slug": "sample-post",
  "categories": [
    {
      "label": "General",
      "value": "e2324fe2-343b-4154-a69c-f2624c94d7ee"
    }
  ],
  "author": "0423169c-5te3-43e6-bb1c-cbbfa4047247",
  "tags": [
    {
      "label": "Social",
      "value": "e43285ae2-343b-4154-a69c-f2624c94d7ee"
    }
  ],
  "excerpt": "",
  "metatitle": "Sample Post",
  "metadescription": ".....",
  "toc_status": true,
  "scheduled": null,
  "content": "<p>This is the content of the post</p>",
  "publish_date": "22/03/2022",
  "is_draft": false,
}

Fields overview

Example Response

{
  "data": {
    "id": "5963423f38-e133-4de5-a3e9-8a18420ee03c"
   },
  "error": null
}

Status code

Publishing the post

To publish a post, set the following fields to their respective values:

• is_draft: false (ensures the post is marked as published).

• scheduled: null (indicates that the post is not scheduled for future publication).

Drafting the post

To draft a post, set the following fields to their respective values:

• is_draft: true(ensures the post is marked as draft).

• scheduled: null (indicates that the post is not scheduled for future publication).

Scheduling the post

To schedlue a post, set the following fields to their respective values:

• is_draft: false (ensures the post is not marked as draft).

• scheduled: 05/01/2026 10:30 AM (Provide any future date and time in the format DD/MM/YYYY HH:MM AM/PM).

Updating the post

To update a post, send a PATCH request to the admin posts URL, including the post ID as a URL parameter.

Endpoint

PATCH /posts/{id}

Example Request

PATCH https://<your-subdomain>.typeflo.io/api/headless/admin/posts/5963423f38-e133-4de5-a3e9-8a18420ee03c
Authorization: Bearer YOUR_ADMIN_API_KEY
Content-Type: application/json

{
  "title": "Sample Post (Updated)",
  "slug": "sample-post",
  "categories": [
    {
      "label": "General",
      "value": "e2324fe2-343b-4154-a69c-f2624c94d7ee"
    }
  ],
  "author": "0423169c-5te3-43e6-bb1c-cbbfa4047247",
  "tags": [
    {
      "label": "Social",
      "value": "e43285ae2-343b-4154-a69c-f2624c94d7ee"
    }
  ],
  "excerpt": "",
  "metatitle": "Sample Post",
  "metadescription": ".....",
  "toc_status": true,
  "content": "<p>This is the content of the post</p>",
  "publish_date": "22/03/2022",
}

Fields overview

Example Response

{
  "data":{
    "message": "Post updated successfully"
   },
  "error": null
}

Status code

Deleting the post

To delete a post, send a DELETE request to the admin posts URL, including the post ID as a URL parameter.

Endpoint

DELETE /posts/{id}

Example Request

DELETE https://<your-subdomain>.typeflo.io/api/headless/admin/posts/5963423f38-e133-4de5-a3e9-8a18420ee03c
Authorization: Bearer YOUR_ADMIN_API_KEY

Example Response

{
  "data":{
    "message": "Post deleted successfully"
   },
  "error": null
}

Status code

2. Category

Create, Update & Delete the categories created in your blog

Endpoints

POST /category
PATCH /category/{id}
DELETE /category/{id}

Creating category

To create a category, send a POST request to the admin category URL, with the body of supported fields in JSON format.

Endpoint

POST /category

Example Request

POST https://<your-subdomain>.typeflo.io/api/headless/admin/category
Authorization: Bearer YOUR_ADMIN_API_KEY
Content-Type: application/json

{
  "slug": "social-media",
  "name": "Social Media",
  "metadescription": ".....",
}

Fields overview

Example Response

{
  "data": {
    "id": "5963423f38-e133-4de5-a3e9-8a18420ee03c"
   },
  "error": null
}

Status code

Updating category

To update a category, send a PATCH request to the admin categories URL, including the category ID as a URL parameter.

Endpoint

PATCH /category/{id}

Example Request

PATCH https://<your-subdomain>.typeflo.io/api/headless/admin/category/5963423f38-e133-4de5-a3e9-8a18420ee03c
Authorization: Bearer YOUR_ADMIN_API_KEY
Content-Type: application/json

{
  "slug": "social-media",
  "name": "Social Media (Updated)",
  "metadescription": ".....",
}

Fields overview

Example Response

{
  "data":{
    "message": "Category updated successfully"
   },
  "error": null
}

Status code

Deleting category

To delete a category, send a DELETE request to the admin categories URL, including the category ID as a URL parameter.

Endpoint

DELETE /category/{id}

Example Request

DELETE https://<your-subdomain>.typeflo.io/api/headless/admin/category/5963423f38-e133-4de5-a3e9-8a18420ee03c
Authorization: Bearer YOUR_ADMIN_API_KEY

Example Response

{
  "data":{
    "message": "Category deleted successfully"
   },
  "error": null
}

Status code

3. Tag

Create, Update & Delete the tags created in your blog

Endpoints

POST /tags
PATCH /tags/{id}
DELETE /tags/{id}

Creating tag

To create a tag, send a POST request to the admin tags URL, with the body of supported fields in JSON format.

Endpoint

POST /tags

Example Request

POST https://<your-subdomain>.typeflo.io/api/headless/admin/tags
Authorization: Bearer YOUR_ADMIN_API_KEY
Content-Type: application/json

{
  "slug": "general",
  "name": "General",
  "metadescription": ".....",
}

Fields overview

Example Response

{
  "data": {
    "id": "5963423f38-e133-4de5-a3e9-8a18420ee03c"
   },
  "error": null
}

Status code

Updating tag

To update a tag, send a PATCH request to the admin tags URL, including the tag ID as a URL parameter.

Endpoint

PATCH /tags/{id}

Example Request

PATCH https://<your-subdomain>.typeflo.io/api/headless/admin/tags/5963423f38-e133-4de5-a3e9-8a18420ee03c
Authorization: Bearer YOUR_ADMIN_API_KEY
Content-Type: application/json

{
  "slug": "general",
  "name": "General (Updated)",
  "metadescription": ".....",
}

Fields overview

Example Response

{
  "data": {
    "message": "Tag updated successfully"
   },
  "error": null
}

Status code

Deleting tag

To delete a tag, send a DELETE request to the admin tags URL, including the tag ID as a URL parameter.

Endpoint

DELETE /tags/{id}

Example Request

DELETE https://<your-subdomain>.typeflo.io/api/headless/admin/tags/5963423f38-e133-4de5-a3e9-8a18420ee03c
Authorization: Bearer YOUR_ADMIN_API_KEY

Example Response

{
  "data": {
    "message": "Tag deleted successfully"
   },
  "error": null
}

Status code