Rest API
List workspaces
GET /api/v1/workspaces
GET
/api/v1/workspaces
List the workspaces you can reach in the account. Use the websiteId of a workspace as the
x-website-id header of every other call.
Notes
- This is the only endpoint that does not need an
x-website-idheader - Users limited to specific workspaces only get those
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” x-api-key
required
string
Your API key from account settings.
x-user-email
required
string
The email address of your user.
x-account-id
required
string
The ID of your account. You can find this in the account settings.
Responses
Section titled “ Responses ”The workspaces you can reach, oldest first.
object
workspaces
Array<object>
object
websiteId
string
name
The workspace name, or its domain when it has no name.
string
domain
string
Unauthorized - invalid API key.