Sites

Site Resources · 26 endpoints

GET/v1/sites

List Sites

app_install_bearerscope: sites:read

Parameters

Field	Type	Required
`limit`query	`integer`	optional
`starting_after`query	`string`	optional
`ending_before`query	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteListResponse`	required
`data.has_more`	`boolean`	required
`data.items`	`SiteObject[]`	required
`data.items[].created_at`	`string`	optional
`data.items[].default_language`	`string`	optional
`data.items[].id`	`string`	required
`data.items[].is_live`	`boolean`	optional
`data.items[].name`	`string`	optional
`data.items[].object`	`string`	optional	site
`data.items[].published_at`	`string`	optional
`data.items[].status`	`string`	optional
`data.items[].subdomain`	`string`	optional
`data.items[].supported_languages`	`string[]`	optional
`data.items[].tagline`	`string`	optional
`data.items[].title`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/development-sessions

Create Source Development Session

app_install_bearerscope: site_drafts:writeidempotent

Parameters

Field	Type	Required	Description
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`files`	`object`	required
`message`	`string`	optional
`name`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceDevelopmentSessionObject`	required
`data.created_at`	`string`format: date-time	required
`data.creation_mode`	`string`	optional	source
`data.expires_at`	`string`	optional
`data.id`	`string`	required
`data.name`	`string`	optional
`data.object`	`string`	optional	site_development_session
`data.preview_url`	`string`	optional
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	optional	open
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/development-sessions \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "files": {},
    "message": "message",
    "name": "name"
  }'

GET/v1/sites/{site_id}

Get Site

app_install_bearerscope: sites:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteObject`	required
`data.created_at`	`string`	optional
`data.default_language`	`string`	optional
`data.id`	`string`	required
`data.is_live`	`boolean`	optional
`data.name`	`string`	optional
`data.object`	`string`	optional	site
`data.published_at`	`string`	optional
`data.status`	`string`	optional
`data.subdomain`	`string`	optional
`data.supported_languages`	`string[]`	optional
`data.tagline`	`string`	optional
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/development-sessions

Create Development Session

app_install_bearerscope: site_drafts:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`name`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteDevelopmentSessionObject`	required
`data.created_at`	`string`format: date-time	required
`data.expires_at`	`string`	optional
`data.id`	`string`	required
`data.name`	`string`	optional
`data.object`	`string`	optional	site_development_session
`data.preview_url`	`string`	optional
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	optional	open
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "name",
    "source_revision": "source_revision"
  }'

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/navigation

Update Development Session Navigation

app_install_bearerscope: site_navigation:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`items`	`object[]`	optional
`menu_key`	`string`	optional
`message`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteNavigationSourceWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.menu_key`	`string`	required
`data.object`	`string`	optional	site_navigation_source_write
`data.path`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/navigation \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [],
    "menu_key": "menu_key",
    "message": "message",
    "source_revision": "source_revision"
  }'

POST/v1/sites/{site_id}/development-sessions/{session_id}/pages

Create Development Session Page

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`description`	`string`	optional
`icon`	`string`	optional
`is_enabled`	`boolean`	optional
`is_in_menu`	`boolean`	optional
`is_published`	`boolean`	optional
`key`	`string`	optional
`menu_order`	`integer`	optional
`message`	`string`	optional
`name`	`string`	required
`page_type`	`string`	optional
`requires_auth`	`boolean`	optional
`seo`	`SitePageSourceSeoRequest`	optional
`slug`	`string`	optional
`source_revision`	`string`	required
`template`	`object`	optional
`template_file`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageSourceWriteObject`	required
`data.action`	`string`	required	created, updated, deleted
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.object`	`string`	optional	site_page_source_write
`data.page_key`	`string`	required
`data.paths`	`string[]`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "description",
    "icon": "icon",
    "is_enabled": true,
    "is_in_menu": true,
    "is_published": true,
    "key": "key"
  }'

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}

Update Development Session Page

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`description`	`string`	optional
`icon`	`string`	optional
`is_enabled`	`boolean`	optional
`is_in_menu`	`boolean`	optional
`is_published`	`boolean`	optional
`menu_order`	`integer`	optional
`message`	`string`	optional
`name`	`string`	optional
`page_type`	`string`	optional
`requires_auth`	`boolean`	optional
`seo`	`SitePageSourceSeoRequest`	optional
`slug`	`string`	optional
`source_revision`	`string`	required
`template_file`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageSourceWriteObject`	required
`data.action`	`string`	required	created, updated, deleted
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.object`	`string`	optional	site_page_source_write
`data.page_key`	`string`	required
`data.paths`	`string[]`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "description",
    "icon": "icon",
    "is_enabled": true,
    "is_in_menu": true,
    "is_published": true,
    "menu_order": 0
  }'

DELETE/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}

Delete Development Session Page

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`message`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SitePageSourceWriteObject`	required
`data.action`	`string`	required	created, updated, deleted
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.object`	`string`	optional	site_page_source_write
`data.page_key`	`string`	required
`data.paths`	`string[]`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id} \
  -X DELETE \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "source_revision": "source_revision"
  }'

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale}

Upsert Development Session Page Content

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`locale`path	`string`	required	Content locale such as en or en-US.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`message`	`string`	optional
`source_revision`	`string`	required
`values`	`object`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentSourceWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.locale`	`string`	required
`data.object`	`string`	optional	site_page_content_source_write
`data.page_id`	`string`	required
`data.path`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "source_revision": "source_revision",
    "values": {}
  }'

DELETE/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale}

Delete Development Session Page Content

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`locale`path	`string`	required	Content locale such as en or en-US.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`message`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentSourceWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.locale`	`string`	required
`data.object`	`string`	optional	site_page_content_source_write
`data.page_id`	`string`	required
`data.path`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale} \
  -X DELETE \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "source_revision": "source_revision"
  }'

POST/v1/sites/{site_id}/development-sessions/{session_id}/preview

Refresh Development Session Preview

app_install_bearerscope: site_drafts:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Returns · 200

Field	Type	Required	Description
`data`	`SiteDevelopmentSessionPreviewObject`	required
`data.expires_at`	`string`format: date-time	required
`data.object`	`string`	optional	site_development_session_preview
`data.preview_url`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/preview \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef"

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/source:batch

Write Development Session Source Batch

app_install_bearerscope: site_theme_files:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`delete_paths`	`string[]`	optional
`files`	`object`	optional
`include_unchanged`	`boolean`	optional
`message`	`string`	optional
`mode`	`string`	optional	archive, patch
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceBatchWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.mode`	`string`	required	archive, patch
`data.object`	`string`	optional	site_source_batch_write
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/source:batch \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_paths": [],
    "files": {},
    "include_unchanged": true,
    "message": "message",
    "mode": "archive",
    "source_revision": "source_revision"
  }'

GET/v1/sites/{site_id}/navigation

Get Navigation

app_install_bearerscope: site_navigation:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteNavigationObject`	required
`data.items`	`SiteNavigationItem[]`	required
`data.items[].is_published`	`boolean`	optional
`data.items[].label`	`string`	required
`data.items[].object`	`string`	optional	site_navigation_item
`data.items[].page_id`	`string`	required
`data.items[].path`	`string`	required
`data.items[].sort_order`	`integer`	optional
`data.menu_key`	`string`	optional
`data.object`	`string`	optional	site_navigation
`data.site_id`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/navigation \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages

List Pages

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`limit`query	`integer`	optional
`starting_after`query	`string`	optional
`ending_before`query	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageListResponse`	required
`data.has_more`	`boolean`	required
`data.items`	`SitePageObject[]`	required
`data.items[].created_at`	`string`	optional
`data.items[].description`	`string`	optional
`data.items[].id`	`string`	required
`data.items[].is_enabled`	`boolean`	optional
`data.items[].is_in_menu`	`boolean`	optional
`data.items[].is_published`	`boolean`	optional
`data.items[].key`	`string`	required
`data.items[].menu_order`	`integer`	optional
`data.items[].object`	`string`	optional	site_page
`data.items[].page_type`	`string`	optional
`data.items[].path`	`string`	optional
`data.items[].requires_auth`	`boolean`	optional
`data.items[].site_id`	`string`	required
`data.items[].slug`	`string`	optional
`data.items[].title`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages/{page_id}

Get Page

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePageObject`	required
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.id`	`string`	required
`data.is_enabled`	`boolean`	optional
`data.is_in_menu`	`boolean`	optional
`data.is_published`	`boolean`	optional
`data.key`	`string`	required
`data.menu_order`	`integer`	optional
`data.object`	`string`	optional	site_page
`data.page_type`	`string`	optional
`data.path`	`string`	optional
`data.requires_auth`	`boolean`	optional
`data.site_id`	`string`	required
`data.slug`	`string`	optional
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages/{page_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages/{page_id}/contents

List Page Contents

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SitePageContentObject[]`	required
`data.items[].content`	`object`	optional
`data.items[].content_hash`	`string`	optional
`data.items[].created_at`	`string`	optional
`data.items[].locale`	`string`	required
`data.items[].menu_label`	`string`	optional
`data.items[].object`	`string`	optional	site_page_content
`data.items[].open_graph`	`SitePageContentOpenGraphObject`	optional
`data.items[].page_id`	`string`	required
`data.items[].published_at`	`string`	optional
`data.items[].sections`	`object`	optional
`data.items[].seo`	`SitePageContentSeoObject`	optional
`data.items[].site_id`	`string`	required
`data.items[].status`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.items[].version`	`integer`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages/{page_id}/contents \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages/{page_id}/contents/{locale}

Get Page Content

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`locale`path	`string`	required	Content locale such as en or en-US.

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentObject`	required
`data.content`	`object`	optional
`data.content_hash`	`string`	optional
`data.created_at`	`string`	optional
`data.locale`	`string`	required
`data.menu_label`	`string`	optional
`data.object`	`string`	optional	site_page_content
`data.open_graph`	`SitePageContentOpenGraphObject`	optional
`data.open_graph.description`	`string`	optional
`data.open_graph.title`	`string`	optional
`data.page_id`	`string`	required
`data.published_at`	`string`	optional
`data.sections`	`object`	optional
`data.seo`	`SitePageContentSeoObject`	optional
`data.seo.canonical_url`	`string`	optional
`data.seo.meta_description`	`string`	optional
`data.seo.meta_keywords`	`string`	optional
`data.seo.meta_title`	`string`	optional
`data.site_id`	`string`	required
`data.status`	`string`	optional
`data.updated_at`	`string`	optional
`data.version`	`integer`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages/{page_id}/contents/{locale} \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/publish-requests

Create Publish Request

app_install_bearerscope: site_publish:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`message`	`string`	optional
`session_id`	`string`	required
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SitePublishRequestObject`	required
`data.approved_at`	`string`	optional
`data.created_at`	`string`format: date-time	required
`data.failed_at`	`string`	optional
`data.failure_reason`	`string`	optional
`data.id`	`string`	required
`data.message`	`string`	optional
`data.object`	`string`	optional	site_publish_request
`data.owner_approval_required`	`boolean`	optional
`data.publish_started_at`	`string`	optional
`data.published_at`	`string`	optional
`data.published_source_revision`	`string`	optional
`data.rejected_at`	`string`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	required	pending_owner_approval, approved, rejected, publishing, published, failed
`data.target_site_id`	`string`	optional
`data.updated_at`	`string`format: date-time	required
`data.validation_checked_at`	`string`format: date-time	required
`data.validation_errors`	`SiteSourceValidationIssue[]`	optional
`data.validation_errors[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_errors[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_errors[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_errors[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_errors[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_errors[].path`	`string`	optional	Source file path that failed validation.
`data.validation_errors[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_errors[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_errors[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`data.validation_warnings`	`SiteSourceValidationIssue[]`	optional
`data.validation_warnings[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_warnings[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_warnings[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_warnings[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_warnings[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_warnings[].path`	`string`	optional	Source file path that failed validation.
`data.validation_warnings[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_warnings[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_warnings[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/publish-requests \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "session_id": "session_id",
    "source_revision": "source_revision"
  }'

GET/v1/sites/{site_id}/publish-requests/{request_id}

Get Publish Request

app_install_bearerscope: site_publish:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`request_id`path	`string`	required	Site publish request public identifier in sprq_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePublishRequestObject`	required
`data.approved_at`	`string`	optional
`data.created_at`	`string`format: date-time	required
`data.failed_at`	`string`	optional
`data.failure_reason`	`string`	optional
`data.id`	`string`	required
`data.message`	`string`	optional
`data.object`	`string`	optional	site_publish_request
`data.owner_approval_required`	`boolean`	optional
`data.publish_started_at`	`string`	optional
`data.published_at`	`string`	optional
`data.published_source_revision`	`string`	optional
`data.rejected_at`	`string`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	required	pending_owner_approval, approved, rejected, publishing, published, failed
`data.target_site_id`	`string`	optional
`data.updated_at`	`string`format: date-time	required
`data.validation_checked_at`	`string`format: date-time	required
`data.validation_errors`	`SiteSourceValidationIssue[]`	optional
`data.validation_errors[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_errors[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_errors[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_errors[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_errors[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_errors[].path`	`string`	optional	Source file path that failed validation.
`data.validation_errors[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_errors[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_errors[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`data.validation_warnings`	`SiteSourceValidationIssue[]`	optional
`data.validation_warnings[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_warnings[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_warnings[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_warnings[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_warnings[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_warnings[].path`	`string`	optional	Source file path that failed validation.
`data.validation_warnings[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_warnings[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_warnings[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/publish-requests/{request_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/publish-status

Get Publish Status

app_install_bearerscope: site_publish:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePublishStatusObject`	required
`data.current_version_id`	`string`	optional
`data.current_version_label`	`string`	optional
`data.current_version_number`	`integer`	optional
`data.has_unpublished_changes`	`boolean`	optional
`data.is_live`	`boolean`	optional
`data.is_published`	`boolean`	optional
`data.live_dirty`	`boolean`	optional
`data.object`	`string`	optional	site_publish_status
`data.preview_dirty`	`boolean`	optional
`data.published_at`	`string`	optional
`data.site_id`	`string`	required
`data.status`	`string`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/publish-status \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/source/archive

Get Source Archive

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceArchiveObject`	required
`data.files`	`object`	optional
`data.generated_at`	`string`format: date-time	required
`data.manifest`	`SiteSourceManifestObject`	required
`data.manifest.files`	`SiteSourceFileEntry[]`	required
`data.manifest.generated_at`	`string`format: date-time	required
`data.manifest.object`	`string`	optional	site_source_manifest
`data.manifest.site_id`	`string`	required
`data.manifest.source_revision`	`string`	required
`data.object`	`string`	optional	site_source_archive
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/archive \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/source/diff

Diff Source

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Request body · application/json

Field	Type	Required	Description
`delete_paths`	`string[]`	optional
`files`	`object`	optional
`include_unchanged`	`boolean`	optional
`mode`	`string`	optional	archive, patch
`source_revision`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceDiffObject`	required
`data.changes`	`SiteSourceDiffChange[]`	required
`data.changes[].binary`	`boolean`	required
`data.changes[].current_checksum`	`string`	optional
`data.changes[].editable`	`boolean`	required
`data.changes[].operation`	`string`	required	added, modified, deleted, unchanged
`data.changes[].path`	`string`	required
`data.changes[].proposed_checksum`	`string`	optional
`data.changes[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.changes[].schema_key`	`string`	optional
`data.generated_at`	`string`format: date-time	required
`data.has_changes`	`boolean`	required
`data.mode`	`string`	required	archive, patch
`data.object`	`string`	optional	site_source_diff
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.summary`	`SiteSourceDiffSummary`	required
`data.summary.added`	`integer`	required
`data.summary.deleted`	`integer`	required
`data.summary.modified`	`integer`	required
`data.summary.unchanged`	`integer`	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/diff \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_paths": [],
    "files": {},
    "include_unchanged": true,
    "mode": "archive",
    "source_revision": "source_revision"
  }'

GET/v1/sites/{site_id}/source/file

Get Source File

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`path`query	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceFileObject`	required
`data.binary`	`boolean`	required
`data.byte_size`	`integer`	required
`data.checksum`	`string`	required
`data.content`	`string`	required
`data.editable`	`boolean`	required
`data.generated`	`boolean`	required
`data.generated_at`	`string`format: date-time	required
`data.media_type`	`string`	required
`data.object`	`string`	optional	site_source_file
`data.path`	`string`	required
`data.role`	`string`	required	editable, generated, forbidden, theme_asset
`data.schema_key`	`string`	optional
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/file \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/source/files

Get Source Files

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceFileListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SiteSourceFileEntry[]`	required
`data.items[].binary`	`boolean`	required
`data.items[].byte_size`	`integer`	required
`data.items[].checksum`	`string`	required
`data.items[].editable`	`boolean`	required
`data.items[].generated`	`boolean`	required
`data.items[].media_type`	`string`	required
`data.items[].path`	`string`	required
`data.items[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.items[].schema_key`	`string`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/files \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/source/manifest

Get Source Manifest

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceManifestObject`	required
`data.files`	`SiteSourceFileEntry[]`	required
`data.files[].binary`	`boolean`	required
`data.files[].byte_size`	`integer`	required
`data.files[].checksum`	`string`	required
`data.files[].editable`	`boolean`	required
`data.files[].generated`	`boolean`	required
`data.files[].media_type`	`string`	required
`data.files[].path`	`string`	required
`data.files[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.files[].schema_key`	`string`	optional
`data.generated_at`	`string`format: date-time	required
`data.object`	`string`	optional	site_source_manifest
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/manifest \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/source/validate

Validate Source

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Request body · application/json

Field	Type	Required	Description
`delete_paths`	`string[]`	optional
`files`	`object`	optional
`include_unchanged`	`boolean`	optional
`mode`	`string`	optional	archive, patch
`source_revision`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceValidationObject`	required
`data.checked_at`	`string`format: date-time	required
`data.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.errors[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.errors[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.errors[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.errors[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.errors[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.errors[].path`	`string`	optional	Source file path that failed validation.
`data.errors[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.errors[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.errors[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`data.files`	`SiteSourceFileEntry[]`	required
`data.files[].binary`	`boolean`	required
`data.files[].byte_size`	`integer`	required
`data.files[].checksum`	`string`	required
`data.files[].editable`	`boolean`	required
`data.files[].generated`	`boolean`	required
`data.files[].media_type`	`string`	required
`data.files[].path`	`string`	required
`data.files[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.files[].schema_key`	`string`	optional
`data.object`	`string`	optional	site_source_validation
`data.site_id`	`string`	required
`data.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.source_context.actor_type`	`string`	optional	api_key, app
`data.source_context.api_client_id`	`string`	optional
`data.source_context.app_id`	`string`	optional
`data.source_context.app_installation_id`	`string`	optional
`data.source_context.channel`	`string`	optional	public_api
`data.source_context.environment`	`string`	optional
`data.source_context.flow`	`string`	optional	api_request
`data.source_context.operation`	`string`	required	source_validate, source_diff, source_first_create, source_batch_write, publish_request_validation
`data.source_context.scope`	`string`	optional
`data.source_context.session_id`	`string`	optional
`data.source_context.site_id`	`string`	required
`data.source_context.surface`	`string`	optional	api
`data.source_context.workspace_id`	`string`	optional
`data.source_revision`	`string`	required
`data.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.warnings[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.warnings[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.warnings[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.warnings[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.warnings[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.warnings[].path`	`string`	optional	Source file path that failed validation.
`data.warnings[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.warnings[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.warnings[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/validate \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_paths": [],
    "files": {},
    "include_unchanged": true,
    "mode": "archive",
    "source_revision": "source_revision"
  }'

Sites

Site Resources · 26 endpoints

GET/v1/sites

List Sites

app_install_bearerscope: sites:read

Parameters

Field	Type	Required
`limit`query	`integer`	optional
`starting_after`query	`string`	optional
`ending_before`query	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteListResponse`	required
`data.has_more`	`boolean`	required
`data.items`	`SiteObject[]`	required
`data.items[].created_at`	`string`	optional
`data.items[].default_language`	`string`	optional
`data.items[].id`	`string`	required
`data.items[].is_live`	`boolean`	optional
`data.items[].name`	`string`	optional
`data.items[].object`	`string`	optional	site
`data.items[].published_at`	`string`	optional
`data.items[].status`	`string`	optional
`data.items[].subdomain`	`string`	optional
`data.items[].supported_languages`	`string[]`	optional
`data.items[].tagline`	`string`	optional
`data.items[].title`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/development-sessions

Create Source Development Session

app_install_bearerscope: site_drafts:writeidempotent

Parameters

Field	Type	Required	Description
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`files`	`object`	required
`message`	`string`	optional
`name`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceDevelopmentSessionObject`	required
`data.created_at`	`string`format: date-time	required
`data.creation_mode`	`string`	optional	source
`data.expires_at`	`string`	optional
`data.id`	`string`	required
`data.name`	`string`	optional
`data.object`	`string`	optional	site_development_session
`data.preview_url`	`string`	optional
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	optional	open
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/development-sessions \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "files": {},
    "message": "message",
    "name": "name"
  }'

GET/v1/sites/{site_id}

Get Site

app_install_bearerscope: sites:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteObject`	required
`data.created_at`	`string`	optional
`data.default_language`	`string`	optional
`data.id`	`string`	required
`data.is_live`	`boolean`	optional
`data.name`	`string`	optional
`data.object`	`string`	optional	site
`data.published_at`	`string`	optional
`data.status`	`string`	optional
`data.subdomain`	`string`	optional
`data.supported_languages`	`string[]`	optional
`data.tagline`	`string`	optional
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/development-sessions

Create Development Session

app_install_bearerscope: site_drafts:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`name`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteDevelopmentSessionObject`	required
`data.created_at`	`string`format: date-time	required
`data.expires_at`	`string`	optional
`data.id`	`string`	required
`data.name`	`string`	optional
`data.object`	`string`	optional	site_development_session
`data.preview_url`	`string`	optional
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	optional	open
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "name",
    "source_revision": "source_revision"
  }'

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/navigation

Update Development Session Navigation

app_install_bearerscope: site_navigation:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`items`	`object[]`	optional
`menu_key`	`string`	optional
`message`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteNavigationSourceWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.menu_key`	`string`	required
`data.object`	`string`	optional	site_navigation_source_write
`data.path`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/navigation \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [],
    "menu_key": "menu_key",
    "message": "message",
    "source_revision": "source_revision"
  }'

POST/v1/sites/{site_id}/development-sessions/{session_id}/pages

Create Development Session Page

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`description`	`string`	optional
`icon`	`string`	optional
`is_enabled`	`boolean`	optional
`is_in_menu`	`boolean`	optional
`is_published`	`boolean`	optional
`key`	`string`	optional
`menu_order`	`integer`	optional
`message`	`string`	optional
`name`	`string`	required
`page_type`	`string`	optional
`requires_auth`	`boolean`	optional
`seo`	`SitePageSourceSeoRequest`	optional
`slug`	`string`	optional
`source_revision`	`string`	required
`template`	`object`	optional
`template_file`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageSourceWriteObject`	required
`data.action`	`string`	required	created, updated, deleted
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.object`	`string`	optional	site_page_source_write
`data.page_key`	`string`	required
`data.paths`	`string[]`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "description",
    "icon": "icon",
    "is_enabled": true,
    "is_in_menu": true,
    "is_published": true,
    "key": "key"
  }'

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}

Update Development Session Page

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`description`	`string`	optional
`icon`	`string`	optional
`is_enabled`	`boolean`	optional
`is_in_menu`	`boolean`	optional
`is_published`	`boolean`	optional
`menu_order`	`integer`	optional
`message`	`string`	optional
`name`	`string`	optional
`page_type`	`string`	optional
`requires_auth`	`boolean`	optional
`seo`	`SitePageSourceSeoRequest`	optional
`slug`	`string`	optional
`source_revision`	`string`	required
`template_file`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageSourceWriteObject`	required
`data.action`	`string`	required	created, updated, deleted
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.object`	`string`	optional	site_page_source_write
`data.page_key`	`string`	required
`data.paths`	`string[]`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "description",
    "icon": "icon",
    "is_enabled": true,
    "is_in_menu": true,
    "is_published": true,
    "menu_order": 0
  }'

DELETE/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}

Delete Development Session Page

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`message`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SitePageSourceWriteObject`	required
`data.action`	`string`	required	created, updated, deleted
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.object`	`string`	optional	site_page_source_write
`data.page_key`	`string`	required
`data.paths`	`string[]`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id} \
  -X DELETE \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "source_revision": "source_revision"
  }'

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale}

Upsert Development Session Page Content

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`locale`path	`string`	required	Content locale such as en or en-US.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`message`	`string`	optional
`source_revision`	`string`	required
`values`	`object`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentSourceWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.locale`	`string`	required
`data.object`	`string`	optional	site_page_content_source_write
`data.page_id`	`string`	required
`data.path`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "source_revision": "source_revision",
    "values": {}
  }'

DELETE/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale}

Delete Development Session Page Content

app_install_bearerscope: site_pages:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`locale`path	`string`	required	Content locale such as en or en-US.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`message`	`string`	optional
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentSourceWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.locale`	`string`	required
`data.object`	`string`	optional	site_page_content_source_write
`data.page_id`	`string`	required
`data.path`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/pages/{page_id}/contents/{locale} \
  -X DELETE \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "source_revision": "source_revision"
  }'

POST/v1/sites/{site_id}/development-sessions/{session_id}/preview

Refresh Development Session Preview

app_install_bearerscope: site_drafts:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Returns · 200

Field	Type	Required	Description
`data`	`SiteDevelopmentSessionPreviewObject`	required
`data.expires_at`	`string`format: date-time	required
`data.object`	`string`	optional	site_development_session_preview
`data.preview_url`	`string`	required
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/preview \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef"

PATCH/v1/sites/{site_id}/development-sessions/{session_id}/source:batch

Write Development Session Source Batch

app_install_bearerscope: site_theme_files:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`session_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`delete_paths`	`string[]`	optional
`files`	`object`	optional
`include_unchanged`	`boolean`	optional
`message`	`string`	optional
`mode`	`string`	optional	archive, patch
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceBatchWriteObject`	required
`data.deleted_count`	`integer`	required
`data.diff`	`SiteSourceDiffObject`	required
`data.diff.changes`	`SiteSourceDiffChange[]`	required
`data.diff.generated_at`	`string`format: date-time	required
`data.diff.has_changes`	`boolean`	required
`data.diff.mode`	`string`	required	archive, patch
`data.diff.object`	`string`	optional	site_source_diff
`data.diff.site_id`	`string`	required
`data.diff.source_revision`	`string`	required
`data.diff.summary`	`SiteSourceDiffSummary`	required
`data.diff.validation`	`SiteSourceValidationObject`	required
`data.mode`	`string`	required	archive, patch
`data.object`	`string`	optional	site_source_batch_write
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.staged_at`	`string`format: date-time	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.written_count`	`integer`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/development-sessions/{session_id}/source:batch \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_paths": [],
    "files": {},
    "include_unchanged": true,
    "message": "message",
    "mode": "archive",
    "source_revision": "source_revision"
  }'

GET/v1/sites/{site_id}/navigation

Get Navigation

app_install_bearerscope: site_navigation:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteNavigationObject`	required
`data.items`	`SiteNavigationItem[]`	required
`data.items[].is_published`	`boolean`	optional
`data.items[].label`	`string`	required
`data.items[].object`	`string`	optional	site_navigation_item
`data.items[].page_id`	`string`	required
`data.items[].path`	`string`	required
`data.items[].sort_order`	`integer`	optional
`data.menu_key`	`string`	optional
`data.object`	`string`	optional	site_navigation
`data.site_id`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/navigation \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages

List Pages

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`limit`query	`integer`	optional
`starting_after`query	`string`	optional
`ending_before`query	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SitePageListResponse`	required
`data.has_more`	`boolean`	required
`data.items`	`SitePageObject[]`	required
`data.items[].created_at`	`string`	optional
`data.items[].description`	`string`	optional
`data.items[].id`	`string`	required
`data.items[].is_enabled`	`boolean`	optional
`data.items[].is_in_menu`	`boolean`	optional
`data.items[].is_published`	`boolean`	optional
`data.items[].key`	`string`	required
`data.items[].menu_order`	`integer`	optional
`data.items[].object`	`string`	optional	site_page
`data.items[].page_type`	`string`	optional
`data.items[].path`	`string`	optional
`data.items[].requires_auth`	`boolean`	optional
`data.items[].site_id`	`string`	required
`data.items[].slug`	`string`	optional
`data.items[].title`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages/{page_id}

Get Page

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePageObject`	required
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.id`	`string`	required
`data.is_enabled`	`boolean`	optional
`data.is_in_menu`	`boolean`	optional
`data.is_published`	`boolean`	optional
`data.key`	`string`	required
`data.menu_order`	`integer`	optional
`data.object`	`string`	optional	site_page
`data.page_type`	`string`	optional
`data.path`	`string`	optional
`data.requires_auth`	`boolean`	optional
`data.site_id`	`string`	required
`data.slug`	`string`	optional
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages/{page_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages/{page_id}/contents

List Page Contents

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SitePageContentObject[]`	required
`data.items[].content`	`object`	optional
`data.items[].content_hash`	`string`	optional
`data.items[].created_at`	`string`	optional
`data.items[].locale`	`string`	required
`data.items[].menu_label`	`string`	optional
`data.items[].object`	`string`	optional	site_page_content
`data.items[].open_graph`	`SitePageContentOpenGraphObject`	optional
`data.items[].page_id`	`string`	required
`data.items[].published_at`	`string`	optional
`data.items[].sections`	`object`	optional
`data.items[].seo`	`SitePageContentSeoObject`	optional
`data.items[].site_id`	`string`	required
`data.items[].status`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.items[].version`	`integer`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages/{page_id}/contents \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/pages/{page_id}/contents/{locale}

Get Page Content

app_install_bearerscope: site_pages:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`page_id`path	`string`	required	Site page public identifier in wpag_<21 Base62> format.
`locale`path	`string`	required	Content locale such as en or en-US.

Returns · 200

Field	Type	Required	Description
`data`	`SitePageContentObject`	required
`data.content`	`object`	optional
`data.content_hash`	`string`	optional
`data.created_at`	`string`	optional
`data.locale`	`string`	required
`data.menu_label`	`string`	optional
`data.object`	`string`	optional	site_page_content
`data.open_graph`	`SitePageContentOpenGraphObject`	optional
`data.open_graph.description`	`string`	optional
`data.open_graph.title`	`string`	optional
`data.page_id`	`string`	required
`data.published_at`	`string`	optional
`data.sections`	`object`	optional
`data.seo`	`SitePageContentSeoObject`	optional
`data.seo.canonical_url`	`string`	optional
`data.seo.meta_description`	`string`	optional
`data.seo.meta_keywords`	`string`	optional
`data.seo.meta_title`	`string`	optional
`data.site_id`	`string`	required
`data.status`	`string`	optional
`data.updated_at`	`string`	optional
`data.version`	`integer`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/pages/{page_id}/contents/{locale} \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/publish-requests

Create Publish Request

app_install_bearerscope: site_publish:writeidempotent

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required
`message`	`string`	optional
`session_id`	`string`	required
`source_revision`	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SitePublishRequestObject`	required
`data.approved_at`	`string`	optional
`data.created_at`	`string`format: date-time	required
`data.failed_at`	`string`	optional
`data.failure_reason`	`string`	optional
`data.id`	`string`	required
`data.message`	`string`	optional
`data.object`	`string`	optional	site_publish_request
`data.owner_approval_required`	`boolean`	optional
`data.publish_started_at`	`string`	optional
`data.published_at`	`string`	optional
`data.published_source_revision`	`string`	optional
`data.rejected_at`	`string`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	required	pending_owner_approval, approved, rejected, publishing, published, failed
`data.target_site_id`	`string`	optional
`data.updated_at`	`string`format: date-time	required
`data.validation_checked_at`	`string`format: date-time	required
`data.validation_errors`	`SiteSourceValidationIssue[]`	optional
`data.validation_errors[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_errors[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_errors[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_errors[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_errors[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_errors[].path`	`string`	optional	Source file path that failed validation.
`data.validation_errors[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_errors[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_errors[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`data.validation_warnings`	`SiteSourceValidationIssue[]`	optional
`data.validation_warnings[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_warnings[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_warnings[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_warnings[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_warnings[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_warnings[].path`	`string`	optional	Source file path that failed validation.
`data.validation_warnings[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_warnings[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_warnings[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/publish-requests \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "message",
    "session_id": "session_id",
    "source_revision": "source_revision"
  }'

GET/v1/sites/{site_id}/publish-requests/{request_id}

Get Publish Request

app_install_bearerscope: site_publish:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`request_id`path	`string`	required	Site publish request public identifier in sprq_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePublishRequestObject`	required
`data.approved_at`	`string`	optional
`data.created_at`	`string`format: date-time	required
`data.failed_at`	`string`	optional
`data.failure_reason`	`string`	optional
`data.id`	`string`	required
`data.message`	`string`	optional
`data.object`	`string`	optional	site_publish_request
`data.owner_approval_required`	`boolean`	optional
`data.publish_started_at`	`string`	optional
`data.published_at`	`string`	optional
`data.published_source_revision`	`string`	optional
`data.rejected_at`	`string`	optional
`data.session_id`	`string`	required
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.status`	`string`	required	pending_owner_approval, approved, rejected, publishing, published, failed
`data.target_site_id`	`string`	optional
`data.updated_at`	`string`format: date-time	required
`data.validation_checked_at`	`string`format: date-time	required
`data.validation_errors`	`SiteSourceValidationIssue[]`	optional
`data.validation_errors[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_errors[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_errors[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_errors[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_errors[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_errors[].path`	`string`	optional	Source file path that failed validation.
`data.validation_errors[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_errors[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_errors[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`data.validation_warnings`	`SiteSourceValidationIssue[]`	optional
`data.validation_warnings[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.validation_warnings[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.validation_warnings[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.validation_warnings[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.validation_warnings[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.validation_warnings[].path`	`string`	optional	Source file path that failed validation.
`data.validation_warnings[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.validation_warnings[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.validation_warnings[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/publish-requests/{request_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/publish-status

Get Publish Status

app_install_bearerscope: site_publish:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SitePublishStatusObject`	required
`data.current_version_id`	`string`	optional
`data.current_version_label`	`string`	optional
`data.current_version_number`	`integer`	optional
`data.has_unpublished_changes`	`boolean`	optional
`data.is_live`	`boolean`	optional
`data.is_published`	`boolean`	optional
`data.live_dirty`	`boolean`	optional
`data.object`	`string`	optional	site_publish_status
`data.preview_dirty`	`boolean`	optional
`data.published_at`	`string`	optional
`data.site_id`	`string`	required
`data.status`	`string`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/publish-status \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/source/archive

Get Source Archive

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceArchiveObject`	required
`data.files`	`object`	optional
`data.generated_at`	`string`format: date-time	required
`data.manifest`	`SiteSourceManifestObject`	required
`data.manifest.files`	`SiteSourceFileEntry[]`	required
`data.manifest.generated_at`	`string`format: date-time	required
`data.manifest.object`	`string`	optional	site_source_manifest
`data.manifest.site_id`	`string`	required
`data.manifest.source_revision`	`string`	required
`data.object`	`string`	optional	site_source_archive
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/archive \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/source/diff

Diff Source

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Request body · application/json

Field	Type	Required	Description
`delete_paths`	`string[]`	optional
`files`	`object`	optional
`include_unchanged`	`boolean`	optional
`mode`	`string`	optional	archive, patch
`source_revision`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceDiffObject`	required
`data.changes`	`SiteSourceDiffChange[]`	required
`data.changes[].binary`	`boolean`	required
`data.changes[].current_checksum`	`string`	optional
`data.changes[].editable`	`boolean`	required
`data.changes[].operation`	`string`	required	added, modified, deleted, unchanged
`data.changes[].path`	`string`	required
`data.changes[].proposed_checksum`	`string`	optional
`data.changes[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.changes[].schema_key`	`string`	optional
`data.generated_at`	`string`format: date-time	required
`data.has_changes`	`boolean`	required
`data.mode`	`string`	required	archive, patch
`data.object`	`string`	optional	site_source_diff
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`data.summary`	`SiteSourceDiffSummary`	required
`data.summary.added`	`integer`	required
`data.summary.deleted`	`integer`	required
`data.summary.modified`	`integer`	required
`data.summary.unchanged`	`integer`	required
`data.validation`	`SiteSourceValidationObject`	required
`data.validation.checked_at`	`string`format: date-time	required
`data.validation.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.validation.files`	`SiteSourceFileEntry[]`	required
`data.validation.object`	`string`	optional	site_source_validation
`data.validation.site_id`	`string`	required
`data.validation.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.validation.source_revision`	`string`	required
`data.validation.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.validation.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/diff \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_paths": [],
    "files": {},
    "include_unchanged": true,
    "mode": "archive",
    "source_revision": "source_revision"
  }'

GET/v1/sites/{site_id}/source/file

Get Source File

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.
`path`query	`string`	required

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceFileObject`	required
`data.binary`	`boolean`	required
`data.byte_size`	`integer`	required
`data.checksum`	`string`	required
`data.content`	`string`	required
`data.editable`	`boolean`	required
`data.generated`	`boolean`	required
`data.generated_at`	`string`format: date-time	required
`data.media_type`	`string`	required
`data.object`	`string`	optional	site_source_file
`data.path`	`string`	required
`data.role`	`string`	required	editable, generated, forbidden, theme_asset
`data.schema_key`	`string`	optional
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/file \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/source/files

Get Source Files

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceFileListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SiteSourceFileEntry[]`	required
`data.items[].binary`	`boolean`	required
`data.items[].byte_size`	`integer`	required
`data.items[].checksum`	`string`	required
`data.items[].editable`	`boolean`	required
`data.items[].generated`	`boolean`	required
`data.items[].media_type`	`string`	required
`data.items[].path`	`string`	required
`data.items[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.items[].schema_key`	`string`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/files \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/sites/{site_id}/source/manifest

Get Source Manifest

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceManifestObject`	required
`data.files`	`SiteSourceFileEntry[]`	required
`data.files[].binary`	`boolean`	required
`data.files[].byte_size`	`integer`	required
`data.files[].checksum`	`string`	required
`data.files[].editable`	`boolean`	required
`data.files[].generated`	`boolean`	required
`data.files[].media_type`	`string`	required
`data.files[].path`	`string`	required
`data.files[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.files[].schema_key`	`string`	optional
`data.generated_at`	`string`format: date-time	required
`data.object`	`string`	optional	site_source_manifest
`data.site_id`	`string`	required
`data.source_revision`	`string`	required
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/manifest \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/sites/{site_id}/source/validate

Validate Source

app_install_bearerscope: site_theme_files:read

Parameters

Field	Type	Required	Description
`site_id`path	`string`	required	Site public identifier in site_<21 Base62> format.

Request body · application/json

Field	Type	Required	Description
`delete_paths`	`string[]`	optional
`files`	`object`	optional
`include_unchanged`	`boolean`	optional
`mode`	`string`	optional	archive, patch
`source_revision`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`SiteSourceValidationObject`	required
`data.checked_at`	`string`format: date-time	required
`data.errors`	`SiteSourceValidationIssue[]`	optional	Blocking validation issues. Source batch writes return these issues inside PublicError.details.errors when validation fails.
`data.errors[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.errors[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.errors[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.errors[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.errors[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.errors[].path`	`string`	optional	Source file path that failed validation.
`data.errors[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.errors[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.errors[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`data.files`	`SiteSourceFileEntry[]`	required
`data.files[].binary`	`boolean`	required
`data.files[].byte_size`	`integer`	required
`data.files[].checksum`	`string`	required
`data.files[].editable`	`boolean`	required
`data.files[].generated`	`boolean`	required
`data.files[].media_type`	`string`	required
`data.files[].path`	`string`	required
`data.files[].role`	`string`	required	editable, generated, forbidden, theme_asset
`data.files[].schema_key`	`string`	optional
`data.object`	`string`	optional	site_source_validation
`data.site_id`	`string`	required
`data.source_context`	`SiteSourceValidationSourceContext`	optional	API/app/site context for the validation run when available.
`data.source_context.actor_type`	`string`	optional	api_key, app
`data.source_context.api_client_id`	`string`	optional
`data.source_context.app_id`	`string`	optional
`data.source_context.app_installation_id`	`string`	optional
`data.source_context.channel`	`string`	optional	public_api
`data.source_context.environment`	`string`	optional
`data.source_context.flow`	`string`	optional	api_request
`data.source_context.operation`	`string`	required	source_validate, source_diff, source_first_create, source_batch_write, publish_request_validation
`data.source_context.scope`	`string`	optional
`data.source_context.session_id`	`string`	optional
`data.source_context.site_id`	`string`	required
`data.source_context.surface`	`string`	optional	api
`data.source_context.workspace_id`	`string`	optional
`data.source_revision`	`string`	required
`data.valid`	`boolean`	required	False when push/sync must be blocked until errors are fixed.
`data.warnings`	`SiteSourceValidationIssue[]`	optional	Advisory validation findings. Warnings are classified by the shared source contract and do not make the source invalid or block writes and publication.
`data.warnings[].category`	`string`	optional	Contracted validation category such as syntax, contract, template, reference, or settings.
`data.warnings[].code`	`string`	required	Machine-readable validation code. Theme source checks may return theme_template_invalid for Jinja source issues and theme_contract_invalid for shared JSON contract issues.
`data.warnings[].doc_url`	`string`	optional	Developer documentation link for the validation rule category.
`data.warnings[].message`	`string`	required	Human-readable issue with the source path, line when available, and fix guidance.
`data.warnings[].param`	`string`	optional	Machine-readable parameter or nested settings path to fix when available.
`data.warnings[].path`	`string`	optional	Source file path that failed validation.
`data.warnings[].schema_key`	`string`	optional	Shared theme schema key when the issue came from JSON contract validation.
`data.warnings[].severity`	`string`	optional	Validation severity. Errors block source writes and publish validation.error, warning
`data.warnings[].source_context`	`SiteSourceIssueSourceContext`	optional	Audit context for the source path that produced the issue: whether it came from the submitted files, the existing base tree, or the resulting validation tree.
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/sites/{site_id}/source/validate \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_paths": [],
    "files": {},
    "include_unchanged": true,
    "mode": "archive",
    "source_revision": "source_revision"
  }'