Skip to main content

REST API

Blog MX exposes a REST API that lets you manage all blog content programmatically — without going through the Magento admin UI.

This is useful when you want to:

  • Import posts, categories, authors, or tags from an external CMS or headless system.
  • Automate content publishing via CI/CD pipelines or scripts.
  • Synchronize blog data with third-party tools (marketing platforms, analytics, etc.).
  • Build custom integrations or mobile apps on top of your blog content.

Base URL​

All endpoints follow Magento's standard REST API pattern:

https://<your-store-domain>/rest/<store-code>/V1/blog/

For the default store view use default as the store code, or omit it entirely to target the global scope:

https://<your-store-domain>/rest/V1/blog/

Authentication​

All Blog MX API endpoints require an admin Bearer token. Obtain one by calling:

POST /rest/V1/integration/admin/token

Request body:

{
  "username": "admin",
  "password": "your-admin-password"
}

Response:

"abc123xyz..."

Include the token in every subsequent request:

Authorization: Bearer abc123xyz...

Filtering and pagination​

All list endpoints accept Magento's standard searchCriteria query parameters.

Example — fetch published posts, newest first, page 2:

GET /rest/V1/blog/posts
  ?searchCriteria[filter_groups][0][filters][0][field]=status
  &searchCriteria[filter_groups][0][filters][0][value]=2
  &searchCriteria[filter_groups][0][filters][0][condition_type]=eq
  &searchCriteria[sort_orders][0][field]=created_at
  &searchCriteria[sort_orders][0][direction]=DESC
  &searchCriteria[currentPage]=2
  &searchCriteria[pageSize]=10

List response envelope:

{
  "items": [ ... ],
  "search_criteria": { ... },
  "total_count": 42
}

Endpoints​

  • Posts — CRUD operations for blog posts
  • Categories — CRUD operations for blog categories
  • Authors — CRUD operations for blog authors
  • Tags — CRUD operations for blog tags