Customers⚓︎
Path⚓︎
/v1/customers
The customer resource is associated with one or more sites. A customer hierarchy can exist where a parent customer oversees one or more child customers. Parent customers can manage the sites of all associated child customers.
Resource Attributes⚓︎
The attributes for the customers resource are detailed below:
| Attribute | Type | Required? | Description |
|---|---|---|---|
| name | String | YES | The name of the customer. |
| extensions | Object | NO | A container for any additional properties or metadata. |
Example⚓︎
{
"name": "acmeCorp",
"extensions": {}
}
Endpoints⚓︎
Request Examples⚓︎
Get a list of customers associated with your admin role:⚓︎
{baseUrl}/v1/customers
This command returns all customers that your account can access, including parent and child customers.
Get a list of all admin accounts for a specific customer:⚓︎
{baseUrl}/v1/customers/<customerID>/accounts
The <customerID> is discovered by selecting a specific customers resource.
Get a list of all sites belonging to a specific customer:⚓︎
{baseUrl}/v1/customers/<customerID>/sites