PageHub Components API
Reusable components (partials) of a site.
Reusable components (partials) of a site.
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-components-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 Components 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: Components
description: Reusable components (partials) of a site.
paths:
/api/v1/sites/{id}/components:
parameters:
- $ref: '#/components/parameters/SiteId'
get:
tags:
- Components
summary: List components
description: The reusable components (partials) of the site's draft and where each is used.
operationId: listSiteComponents
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
components:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
usage:
type: object
properties:
instances:
type: integer
pages:
type: integer
required:
- id
- name
required:
- components
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/SiteFormatChanged'
x-auth: session-or-key
/api/v1/sites/{id}/components/{name}:
parameters:
- $ref: '#/components/parameters/SiteId'
- name: name
in: path
required: true
schema:
type: string
description: The component's `id`.
patch:
tags:
- Components
summary: Rename a component
description: Renames the component and every `{% render %}` tag of it, as one write.
operationId: renameSiteComponent
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
required:
- name
responses:
'200':
$ref: '#/components/responses/ComponentId'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/ComponentConflict'
'422':
$ref: '#/components/responses/WriteRejected'
'503':
$ref: '#/components/responses/Maintenance'
x-auth: session-or-key
x-rate-limit: site_save
delete:
tags:
- Components
summary: Delete a component
description: Refused with 409 `in_use` while anything still renders it.
operationId: deleteSiteComponent
responses:
'200':
$ref: '#/components/responses/ComponentId'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/ComponentConflict'
'422':
$ref: '#/components/responses/WriteRejected'
'503':
$ref: '#/components/responses/Maintenance'
x-auth: session-or-key
x-rate-limit: site_save
components:
responses:
ComponentId:
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
required:
- id
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'
SiteFormatChanged:
description: 'The site is not an HTML-first site (`error: site_format_changed`).'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
ComponentConflict:
description: '`in_use` (with `usage`) or `version_conflict` (a file changed meanwhile).'
content:
application/json:
schema:
type: object
properties:
error:
type: string
enum:
- in_use
- version_conflict
- bad_request
message:
type: string
usage:
type: object
additionalProperties: true
required:
- error
Maintenance:
description: 'Writes are paused for maintenance (`error: maintenance`, `Retry-After` header).'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
parameters:
SiteId:
name: id
in: path
required: true
schema:
type: string
description: The site's id.
schemas:
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
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.