List your WP Engine accounts

GET

/accounts

Description

Use this to list your WP Engine accounts.

Authorizations

• basicAuth

Parameters

Query Parameters

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

Responses

200

List of WP Engine accounts

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

eeda3227-9a39-46ae-9e14-20958bb4e6c9

name

required

The account name

string

Example

joesaccount

nickname

required

The account nickname

string

Example

joesaccount

400

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)

401

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

429

Too many requests

503

Service unavailable