Skip to content

List sync items without document bodies

GET
/wp-json/wp2/studio-sync/v1/sync/items
curl --request GET \
--url 'https://example.com/wp-json/wp2/studio-sync/v1/sync/items?post_type=page%2Cmodal' \
--header 'Authorization: Bearer <token>'

Catalog of syncable documents (page and modal by default): id, slug, editor, hash. Page bodies are not included — fetch them with GET …/posts/{id}.

post_type
string
default: page,modal

Comma-separated post types (Studio Sync, default page,modal).

OK

Media typeapplication/json
object
success

Success flag (often Studio/License envelope).

boolean
items

Array of items (section order, batch, DataTables — depending on the route).

Array<object>
object
post_id

WordPress post ID.

integer
post_type

Comma-separated post types (Studio Sync, default page,modal).

string
slug

Slug (site, post, or section).

string
editor

Page editor (gutenberg / elementor / turbo).

string
hash

Document content hash.

string
title

Title.

string
status

Status (build, post, or license — depending on the operation).

string
Examplegenerated
{
"success": true,
"items": [
{
"post_id": 1,
"post_type": "example",
"slug": "example",
"editor": "example",
"hash": "example",
"title": "example",
"status": "example"
}
]
}

Studio_sync_missing_auth / studio_sync_invalid_token

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}

Studio_sync_insufficient_permissions / studio_sync_connection_revoked

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}