List the workspace's sites
Permission: any member; lists only the sites you reach
apiTokenAuthorizationBearer <token>An API token (mwp_…) from Settings → API tokens. Only accepted on this host.
status?string|nullinclude_staging?Include StagingInclude staging copies. Off by default because this feeds the site switcher, the clone-into picker and anything that counts sites — a staging copy in any of those is the one that eventually gets cloned over by accident. Callers that opt in get them mixed into the same list and must tell them apart by parent_site_id.
falseinclude_deleting?Include DeletingAlso return sites whose deletion is still running (status deleted, delete task not yet finished), so a table can show the teardown in progress. Off by default: a site being deleted must not appear in a clone target or restore picker.
falselimit?LimitItems per page (1–100).
1 <= value <= 10050cursor?|Opaque cursor from a previous page's next_cursor.
Successful Response
application/json- response
success*booleandata*The result; on an error, details such as code and permission.
message*stringstatus_code*integertimestamp*stringdate-timemeta?|nullcurl -X GET "https://example.com/v1/sites"{ "message": "string", "status_code": 0, "timestamp": "2019-08-24T14:15:22Z", "meta": {}, "success": true, "data": { "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "stack_number": 0, "server_id": "820efca4-4a15-4ab7-82fc-9e76f6d61325", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627", "domain_name": "string", "custom_domain": "string", "site_label": "string", "region": "string", "status": "string", "message": "string", "site_type": "string", "template_id": null, "template_version": null, "wp_version": "string", "wp_installed": true, "php_hardened": null, "config_profile": null, "php_version": "string", "storage_limit": 0, "storage_usage": 0, "maintenance_mode": true, "notes": null, "notes_updated_at": null, "notes_updated_by": null, "parent_site_id": null, "expires_at": null, "extend_count": 0, "demo_expires_at": null, "demo_stopped_at": null, "demo_converted_at": null, "site_lock": true, "lock_reason": "string", "locked_at": "2019-08-24T14:15:22Z", "billing_suspended_at": "2019-08-24T14:15:22Z", "admin_suspended_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z" } ], "next_cursor": null }}