Skip to content
WP Engine |Hosting Platform API

List your sites

GET
/sites
limit
integer
default: 100 <= 100

(Optional) The number of records to return

offset
integer
0

(Optional) The first record of the result set to be retrieved

account_id
string format: uuid

(Optional) The uuid of an account

List of sites

object
previous

Path to the previous page of results

string
Example
https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=0
next

Path to the next page of results

string
Example
https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=200
count

The total number of results

integer
Example
225
results
Array<object>
object
id
required
string format: uuid
Example
28c78b6d-c2da-4f09-85f5-1ad588089b2d
name
required
string
Example
Torque Magazine
account
required
object
id

The account ID

string format: uuid
Example
eeda3227-9a39-46ae-9e14-20958bb4e6c9
group_name
string
Example
Overdue
tags
Array<string>
Example
[
"tag1",
"tag2",
"tag3"
]
created_at

The date and time the site was created in UTC

string format: date-time
Example
2025-07-10T09:59:58.684Z
sandbox

Whether the site is a sandbox site

boolean
transferable

Whether the site is transferable

boolean
installs
Array
object
id
string format: uuid
Example
294deacc-d8b8-4005-82c4-0727ba8ddde0
name
string
Example
torquemag
environment
string
Allowed values: production staging development
cname

Returns the CNAME of the install

string
Example
mywebsite.wpengine.com
php_version

The PHP version used to run WordPress

string
Example
7.3
is_multisite
boolean

Bad Request

object
message
required

A message regarding the error that occurred on the server

string
Example
Invalid Site: Name cannot be empty.
documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string
errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>
object
resource
required

The name of the resource that was being processed when the error occurred

string
Example
Site
field
required

(Optional) The specific field associated with the error

string
Example
name
type
required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string
Example
invalid_value
code
required

(Optional) A machine code relating to the error that occurred with the field and resource

string
Example
too_long
message
required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string
Example
Name is too long (maximum is 40 characters)

Authentication Error

object
message
required

A message regarding the error that occurred on the server

string
Example
Bad Credentials
documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Too many requests

Service unavailable