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`

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
`data`	`SiteObject`	required
`data.created_at`	`string`	optional
`data.default_language`	`string`	optional
`data.id`	`string`	required
`data.is_live`	`boolean`	optional

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

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	Description
`items`	`object[]`	optional

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
`description`	`string`	optional
`icon`

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

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

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`

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`

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

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

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
`data`	`SiteNavigationObject`	required
`data.items`	`SiteNavigationItem[]`	required
`data.items[].is_published`	`boolean`	optional
`data.items[].label`	`string`	required
`data.items[].object`	`string`

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`

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
`data`	`SitePageObject`	required
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.id`

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
`data`	`SitePageContentListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SitePageContentObject[]`	required

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

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

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
`data`	`SitePublishRequestObject`	required
`data.approved_at`	`string`	optional
`data.created_at`	`string`format: date-time	required

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
`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`

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
`data`	`SiteSourceArchiveObject`	required
`data.files`	`object`	optional
`data.generated_at`	`string`format: date-time	required
`data.manifest`	`SiteSourceManifestObject`	required
`data.manifest.files`

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`

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
`data`	`SiteSourceFileObject`	required
`data.binary`	`boolean`	required
`data.byte_size`	`integer`	required
`data.checksum`	`string`

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
`data`	`SiteSourceFileListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SiteSourceFileEntry[]`	required
`data.items[].binary`	`boolean`	required
`data.items[].byte_size`	`integer`

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
`data`	`SiteSourceManifestObject`	required
`data.files`	`SiteSourceFileEntry[]`	required
`data.files[].binary`	`boolean`	required
`data.files[].byte_size`	`integer`	required
`data.files[].checksum`

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`

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`

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
`data`	`SiteObject`	required
`data.created_at`	`string`	optional
`data.default_language`	`string`	optional
`data.id`	`string`	required
`data.is_live`	`boolean`	optional

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

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	Description
`items`	`object[]`	optional

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
`description`	`string`	optional
`icon`

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

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

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`

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`

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

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

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
`data`	`SiteNavigationObject`	required
`data.items`	`SiteNavigationItem[]`	required
`data.items[].is_published`	`boolean`	optional
`data.items[].label`	`string`	required
`data.items[].object`	`string`

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`

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
`data`	`SitePageObject`	required
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.id`

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
`data`	`SitePageContentListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SitePageContentObject[]`	required

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

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

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
`data`	`SitePublishRequestObject`	required
`data.approved_at`	`string`	optional
`data.created_at`	`string`format: date-time	required

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
`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`

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
`data`	`SiteSourceArchiveObject`	required
`data.files`	`object`	optional
`data.generated_at`	`string`format: date-time	required
`data.manifest`	`SiteSourceManifestObject`	required
`data.manifest.files`

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`

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
`data`	`SiteSourceFileObject`	required
`data.binary`	`boolean`	required
`data.byte_size`	`integer`	required
`data.checksum`	`string`

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
`data`	`SiteSourceFileListResponse`	required
`data.has_more`	`boolean`	optional
`data.items`	`SiteSourceFileEntry[]`	required
`data.items[].binary`	`boolean`	required
`data.items[].byte_size`	`integer`

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
`data`	`SiteSourceManifestObject`	required
`data.files`	`SiteSourceFileEntry[]`	required
`data.files[].binary`	`boolean`	required
`data.files[].byte_size`	`integer`	required
`data.files[].checksum`

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`

`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

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

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

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

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