Download OpenAPI specification:
Token-authenticated REST API exposed by the Renick.TailorCompanion October CMS plugin. Lets a native client browse, sync and edit Tailor content offline-first. All responses use a { "data": ..., "meta": ... } envelope; errors use { "error": { "code", "message" } }.
Manual pairing path. Verifies a backend user's login and password and returns a bearer token. Hard-throttled (5/min). The primary pairing path is a QR code generated in the backend.
| login required | string |
| password required | string <password> |
| device_name | string <= 120 characters |
{- "login": "string",
- "password": "pa$$word",
- "device_name": "string"
}{- "data": {
- "token": "string",
- "token_prefix": "string",
- "name": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "user": {
- "login": "string",
- "name": "string"
}
}
}The sites the client can switch between. Send the chosen site as an X-Tailor-Site: <id> header on all content endpoints; without it the primary site is used. Single-site installs report one site with multisite: false.
{- "data": [
- {
- "id": 0,
- "name": "string",
- "code": "string",
- "locale": "string",
- "is_primary": true,
- "is_enabled": true
}
], - "meta": {
- "multisite": true,
- "primary_site_id": 0
}
}{- "data": {
- "api_version": 1,
- "plugin_version": "string",
- "october_version": "string",
- "user": {
- "login": "string",
- "name": "string"
}, - "schema_version": "string",
- "server_time": "2019-08-24T14:15:22Z",
- "features": {
- "static_pages": {
- "available": true,
- "schema_version": "string"
}
}, - "branding": {
- "title": "string",
- "logo_url": "string",
- "preview_url": "string"
}
}
}Mints a single-use, short-lived URL that logs the token's user into the OctoberCMS backend. The app opens the returned URL in a web view (a top-level navigation cannot carry the Bearer header, so identity is bridged via a one-time nonce). The redeeming route is not part of this API contract.
{- "data": {
- "url": "string",
- "expires_in": 60
}
}Dependency-free deploy check. Reports the build constant compiled into the running plugin code, so it confirms which code is actually live — independent of DB migrations and PHP OPcache — even when the optional static-pages subsystem is misconfigured. A 404 means the deployed code predates this endpoint; an old build means files updated but OPcache / PHP-FPM still serve stale bytecode.
{- "data": {
- "api_version": 1,
- "build": "2026-07-10.1",
- "plugin_version": "string",
- "october_version": "string",
- "server_time": "2019-08-24T14:15:22Z"
}
}Every entry blueprint and global aggregated into the wire structure the client renders forms from. ETag equals the global schema_version; send it back as If-None-Match to get 304.
| If-None-Match | string |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "handle": "Blog\\Post",
- "handle_slug": "string",
- "name": "string",
- "type": "entry",
- "structure": {
- "max_depth": 0,
- "tree": true
}, - "drafts": true,
- "multisite": true,
- "groups": [
- "string"
], - "fingerprint": "string",
- "entry_count": 0,
- "fields": [
- {
- "name": "string",
- "type": "string",
- "kind": "scalar",
- "label": "string",
- "tab": "string",
- "span": "string",
- "comment": "string",
- "hidden": true,
- "required": true,
- "readonly": true,
- "custom": true,
- "implicit": true,
- "config": { }
}
]
}
], - "meta": {
- "schema_version": "string"
}
}| uuid required | string <uuid> Blueprint uuid (from /schema). |
| cursor | integer Default: 0 Last seen entry id; page returns entries with a greater id. |
| per_page | integer <= 200 Default: 50 |
{- "data": [
- {
- "id": 0,
- "blueprint_uuid": "50cc7e73-143c-4d56-b17c-fc1d9f597a7e",
- "is_global": true,
- "content_group": "string",
- "title": "string",
- "slug": "string",
- "is_enabled": true,
- "published_at": "2019-08-24T14:15:22Z",
- "expired_at": "2019-08-24T14:15:22Z",
- "site_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "fields": { },
- "relation_labels": {
- "property1": [
- {
- "id": 0,
- "title": "string"
}
], - "property2": [
- {
- "id": 0,
- "title": "string"
}
]
}
}
], - "meta": {
- "total": 0,
- "has_more": true,
- "next_cursor": 0
}
}| uuid required | string <uuid> Blueprint uuid (from /schema). |
| id required | integer |
{- "data": {
- "id": 0,
- "blueprint_uuid": "50cc7e73-143c-4d56-b17c-fc1d9f597a7e",
- "is_global": true,
- "content_group": "string",
- "title": "string",
- "slug": "string",
- "is_enabled": true,
- "published_at": "2019-08-24T14:15:22Z",
- "expired_at": "2019-08-24T14:15:22Z",
- "site_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "fields": { },
- "relation_labels": {
- "property1": [
- {
- "id": 0,
- "title": "string"
}
], - "property2": [
- {
- "id": 0,
- "title": "string"
}
]
}
}
}A recordfinder field associates entries with a regular (non-Tailor) model that the app never syncs. This endpoint searches that model so the app can offer a picker. The model class is resolved server-side from the field definition — the client only names the blueprint and field. Results use the field's nameFrom column as the title.
| uuid required | string <uuid> Blueprint uuid (from /schema). |
| field required | string The recordfinder field's name. |
| q | string Search term matched against the display column. |
| cursor | integer Default: 0 Last seen record id; page returns records with a greater id. |
| per_page | integer <= 100 Default: 25 |
{- "data": [
- {
- "id": 0,
- "title": "string",
- "description": "string"
}
], - "meta": {
- "has_more": true,
- "next_cursor": 0
}
}Globals have exactly one record — there is no list. Relation and repeater fields on globals are read-only via the API.
| uuid required | string <uuid> Blueprint uuid (from /schema). |
{- "data": {
- "id": 0,
- "blueprint_uuid": "50cc7e73-143c-4d56-b17c-fc1d9f597a7e",
- "is_global": true,
- "content_group": "string",
- "title": "string",
- "slug": "string",
- "is_enabled": true,
- "published_at": "2019-08-24T14:15:22Z",
- "expired_at": "2019-08-24T14:15:22Z",
- "site_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "fields": { },
- "relation_labels": {
- "property1": [
- {
- "id": 0,
- "title": "string"
}
], - "property2": [
- {
- "id": 0,
- "title": "string"
}
]
}
}
}Coalesced create/update/delete records since a cursor. Omit since to signal the client has no cursor yet (full pull required). A since older than pruned history returns 410.
| since | integer Cursor from a previous response's |
{- "data": [
- {
- "cursor": 0,
- "blueprint_uuid": "50cc7e73-143c-4d56-b17c-fc1d9f597a7e",
- "record_id": 0,
- "action": "created"
}
], - "meta": {
- "full_pull_required": true,
- "latest_cursor": 0,
- "has_more": true
}
}Operations are applied in order; each yields an independent result (ok / conflict / error). Blueprint validation always runs. Unknown or read-only fields are returned as warnings, never dropped silently. Max 100 ops per batch.
required | Array of objects (BatchOp) <= 100 items |
{- "ops": [
- {
- "op": "create",
- "blueprint_uuid": "50cc7e73-143c-4d56-b17c-fc1d9f597a7e",
- "local_id": "string",
- "id": 0,
- "base_updated_at": "2019-08-24T14:15:22Z",
- "content_group": "string",
- "fields": { }
}
]
}{- "data": {
- "results": [
- {
- "status": "ok",
- "op": "string",
- "local_id": "string",
- "id": 0,
- "entry": {
- "id": 0,
- "blueprint_uuid": "50cc7e73-143c-4d56-b17c-fc1d9f597a7e",
- "is_global": true,
- "content_group": "string",
- "title": "string",
- "slug": "string",
- "is_enabled": true,
- "published_at": "2019-08-24T14:15:22Z",
- "expired_at": "2019-08-24T14:15:22Z",
- "site_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "fields": { },
- "relation_labels": {
- "property1": [
- {
- "id": 0,
- "title": "string"
}
], - "property2": [
- {
- "id": 0,
- "title": "string"
}
]
}
}, - "server_state": {
- "id": 0,
- "blueprint_uuid": "50cc7e73-143c-4d56-b17c-fc1d9f597a7e",
- "is_global": true,
- "content_group": "string",
- "title": "string",
- "slug": "string",
- "is_enabled": true,
- "published_at": "2019-08-24T14:15:22Z",
- "expired_at": "2019-08-24T14:15:22Z",
- "site_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "fields": { },
- "relation_labels": {
- "property1": [
- {
- "id": 0,
- "title": "string"
}
], - "property2": [
- {
- "id": 0,
- "title": "string"
}
]
}
}, - "warnings": [
- {
- "field": "string",
- "code": "unknown_field",
- "message": "string",
- "value": null
}
], - "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
]
}, - "meta": {
- "applied": 0,
- "conflicts": 0,
- "errors": 0
}
}Multipart upload. Returns a file descriptor whose id is then referenced in a fileupload field of a subsequent batch op. Max 50 MB; only safe media/document extensions are accepted.
| file required | string <binary> |
{
}Returns the last N lines of the OctoberCMS application log for a console view in the app. Read as a bounded reverse-tail, so a large log stays fast. Gated by the logs_enabled backend setting.
| lines | integer [ 1 .. 10000 ] Default: 1000 How many trailing lines to return (clamped to 10000). |
{- "data": [
- "string"
], - "meta": {
- "file": "string",
- "exists": true,
- "size_bytes": 0,
- "returned": 0,
- "truncated": true,
- "max_lines": 0
}
}Static pages (optional RainLab.Pages integration). All endpoints answer 404 feature_unavailable when the integration is missing or disabled; clients discover availability via features.static_pages on /ping.
Every static-page layout aggregated into a form definition using the same wire field format as /schema, so clients render page editors with no extra field UI. ETag equals pages_schema_version; send it back as If-None-Match to get 304.
| If-None-Match | string |
{- "data": {
- "layouts": [
- {
- "file_name": "string",
- "name": "string",
- "use_content": true,
- "fingerprint": "string",
- "fields": [
- {
- "name": "string",
- "type": "string",
- "kind": "scalar",
- "label": "string",
- "tab": "string",
- "span": "string",
- "comment": "string",
- "hidden": true,
- "required": true,
- "readonly": true,
- "custom": true,
- "implicit": true,
- "config": { }
}
]
}
]
}, - "meta": {
- "pages_schema_version": "string"
}
}The nested page tree with per-page metadata and a content_hash (sha256 of the raw file). Clients diff hashes to pull only changed pages — there is no journal for static pages.
{- "data": {
- "pages": [
- {
- "file_name": "string",
- "title": "string",
- "url": "string",
- "layout": "string",
- "is_hidden": true,
- "navigation_hidden": true,
- "content_hash": "string",
- "mtime": "2019-08-24T14:15:22Z",
- "children": [
- { }
]
}
]
}, - "meta": {
- "pages_schema_version": "string"
}
}| fileName required | string^[A-Za-z0-9\-_.]+$ Static page base file name without extension (from /pages/tree). |
{- "data": {
- "file_name": "string",
- "title": "string",
- "url": "string",
- "layout": "string",
- "is_hidden": true,
- "navigation_hidden": true,
- "meta_title": "string",
- "meta_description": "string",
- "fields": { },
- "viewbag_extra": { },
- "content_hash": "string",
- "mtime": "2019-08-24T14:15:22Z"
}
}Applies field changes to an existing page (v1 does not create, delete, move or rename pages). Send only changed fields. base_hash is the content_hash the edit was based on — a mismatch returns 409 with the current server page. url and layout are read-only; read-only/unknown fields come back as warnings with their rejected value.
| fileName required | string^[A-Za-z0-9\-_.]+$ Static page base file name without extension (from /pages/tree). |
| base_hash | string or null content_hash the edit was based on; omit to force-apply. |
object Changed field values keyed by field name. | |
object Replacement lossless extras; omit to leave untouched. |
{- "base_hash": "string",
- "fields": { },
- "viewbag_extra": { }
}{- "data": {
- "file_name": "string",
- "title": "string",
- "url": "string",
- "layout": "string",
- "is_hidden": true,
- "navigation_hidden": true,
- "meta_title": "string",
- "meta_description": "string",
- "fields": { },
- "viewbag_extra": { },
- "content_hash": "string",
- "mtime": "2019-08-24T14:15:22Z"
}, - "meta": {
- "warnings": [
- {
- "field": "string",
- "code": "unknown_field",
- "message": "string",
- "value": null
}
]
}
}