PageHub Blocks API
The block library and placing a block into a page.
The block library and placing a block into a page.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/pagehub-dev:pagehub-dev-blocks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: PageHub Blocks API
version: 1.0.0
description: 'The public REST API of PageHub, called with a `ph_` API key (`Authorization: Bearer ph_...`), plus the one webhook the platform calls on a white-label tenant''s server (`fetchPage`).
A site is HTML + Liquid files: its pages are files (`pages/*.liquid`), written through the files API; the page routes manage each page''s record (name, slug, SEO, access). Writes land in the site''s draft; `PUT /api/v1/sites/{id}` with `published: true` makes the draft live.
The headless content API (`/api/v1/content/...`) is described by its own document (`GET /api/v1/content/openapi.json`); `GET /api/openapi.json` serves this document with it merged in.
The routes also accept the dashboard''s session cookie from the dashboard itself; only the API key is the public contract.
Every operation carries two extension fields. `x-auth` says who may call it: `api-key` (a `ph_` key), `session-or-key` (the dashboard''s own session, or a key), `optional-key` (public, a key widens what you see), `admin-key` (a platform admin''s key), `session` (the dashboard session only; an API key is refused) or `public`. `x-rate-limit` names the rate-limit rule (see the rate-limiting guide) when the route has one; most routes limit per user, public routes per IP.'
contact:
name: PageHub
url: https://pagehub.dev/developers
servers:
- url: https://pagehub.dev
description: PageHub
security:
- bearerAuth: []
tags:
- name: Blocks
description: The block library and placing a block into a page.
paths:
/api/v1/liquid-blocks:
get:
tags:
- Blocks
summary: Browse the block library
description: The public library plus the caller's own saved blocks, without their source. Ask the block's route for the ones you use.
operationId: listLiquidBlocks
parameters:
- name: q
in: query
required: false
schema:
type: string
- name: category
in: query
required: false
schema:
type: string
- name: style
in: query
required: false
schema:
type: string
- name: limit
in: query
required: false
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
blocks:
type: array
items:
$ref: '#/components/schemas/LiquidBlockSummary'
required:
- blocks
'401':
$ref: '#/components/responses/Unauthorized'
x-auth: session-or-key
/api/v1/liquid-blocks/{slug}:
get:
tags:
- Blocks
summary: Read one block as Liquid
operationId: getLiquidBlock
parameters:
- name: slug
in: path
required: true
schema:
type: string
description: The block's slug.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
block:
type: object
additionalProperties: true
properties:
slug:
type: string
name:
type: string
category:
type: string
styles:
type: array
items:
type: string
description:
type: string
source:
type: string
description: The block's Liquid.
notes: {}
required:
- slug
- name
- source
required:
- block
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-auth: session-or-key
/api/v1/sites/{id}/blocks:
post:
tags:
- Blocks
summary: Place a library block into a page
description: Adds the block's Liquid (with fresh ids) to a page file of the draft as one write. `pageId` or `path` picks the page, the home page by default. `position` is `end` (default, before the footer) or `start`; `before` or `after` is text that occurs once in the page.
operationId: placeSiteBlock
parameters:
- $ref: '#/components/parameters/SiteId'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
slug:
type: string
pageId:
type: string
path:
type: string
position:
type: string
enum:
- start
- end
before:
type: string
after:
type: string
required:
- slug
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
path:
type: string
version:
type: string
source:
type: string
required:
- path
- version
- source
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
description: A conflict (`error` says which).
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'422':
$ref: '#/components/responses/WriteRejected'
'429':
$ref: '#/components/responses/RateLimited'
'503':
$ref: '#/components/responses/Maintenance'
x-auth: session-or-key
x-rate-limit: site_save
components:
schemas:
LiquidBlockSummary:
type: object
additionalProperties: true
properties:
slug:
type: string
name:
type: string
category:
type: string
subcategory:
type: string
styles:
type: array
items:
type: string
description:
type: string
saved:
type: boolean
required:
- slug
- name
- category
ApiError:
type: object
description: The error body of the management routes. The content API uses `Error` instead.
properties:
error:
type: string
description: A message, or a code such as `version_conflict`, `lint`, `maintenance`, `site_format_changed`.
message:
type: string
code:
type: string
upgrade:
type: boolean
description: True when the plan is the reason.
required:
- error
additionalProperties: true
parameters:
SiteId:
name: id
in: path
required: true
schema:
type: string
description: The site's id.
responses:
Unauthorized:
description: Missing, malformed or invalid `ph_` API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
BadRequest:
description: The request is malformed or refused (`error`, often `message`).
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
WriteRejected:
description: 'A file write was refused: `lint` (422, with `issues` and `path`), too large (413), or another `rejected` reason.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
NotFound:
description: No such site, or the key has no access to it, or no such resource under it.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
Forbidden:
description: The key's user lacks the role this needs, or a plan limit applies.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
RateLimited:
description: Too many requests.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
Maintenance:
description: 'Writes are paused for maintenance (`error: maintenance`, `Retry-After` header).'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: A `ph_` API key (a user's key, or a tenant's).
tenantAuthToken:
type: apiKey
in: header
name: x-pagehub-auth
description: The tenant's token, sent by PageHub on every webhook call so the tenant can check the request came from PageHub.