Clients Endpoints

Use these endpoints to manage clients and custom client fields in MainWP Dashboard.

Use the MainWP Postman collection as the source of truth for request and response schemas.

{id_or_email} accepts either a numeric client ID or a client email.

Route Matrix

Client Records

Method	Path	Purpose	Key Params
GET	`/clients`	List clients	`page`, `per_page`, `search`, `include`, `exclude`, `status`
GET	`/clients/count`	Count clients	Collection filters
POST	`/clients/add`	Create a client	`name`, `client_email`, optional address/contact fields
GET	`/clients/{id_or_email}`	Get one client	`id_or_email`
POST, PUT, PATCH	`/clients/{id_or_email}/edit`	Edit a client	Editable client fields
DELETE	`/clients/{id_or_email}/remove`	Delete a client	`id_or_email`
GET	`/clients/{id_or_email}/sites`	List client sites	`id_or_email`
GET	`/clients/{id_or_email}/sites/count`	Count client sites	`id_or_email`
GET	`/clients/{id_or_email}/costs`	List client costs	`id_or_email`
POST, PUT, PATCH	`/clients/{id_or_email}/suspend`	Suspend client	`id_or_email`
POST, PUT, PATCH	`/clients/{id_or_email}/unsuspend`	Unsuspend client	`id_or_email`
POST	`/clients/batch`	Batch client create/update/delete	`create[]`, `update[]`, `delete[]`

Client Fields

Method	Path	Purpose	Key Params
GET	`/clients/fields`	List client fields	`search`, `include`, `exclude`, `page`, `per_page`, `pre_page` (deprecated)
POST	`/clients/fields/add`	Create a client field	`name`, `description`
PUT, PATCH	`/clients/fields/{id_name}/edit`	Edit a client field	`name`, `description`
DELETE	`/clients/fields/{id_name}/delete`	Delete a client field	`{id_name}` (field id or field name)

For GET /clients/fields, use per_page to set the number of fields returned per page. The pre_page parameter remains available as a deprecated alias for backward compatibility.

Representative Requests

Create a client

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme","client_email":"[email protected]","client_phone":"+1-555-0100"}' \
  "https://your-dashboard.com/wp-json/mainwp/v2/clients/add"

{
  "success": 1,
  "message": "Client added successfully.",
  "data": {
    "id": 34,
    "name": "Acme",
    "client_email": "[email protected]"
  }
}

Create a client field

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Account Manager","description":"Primary owner"}' \
  "https://your-dashboard.com/wp-json/mainwp/v2/clients/fields/add"

{
  "success": 1,
  "message": "Client field created successfully.",
  "data": {
    "field_id": 6,
    "name": "Account Manager",
    "description": "Primary owner"
  }
}

⌘I

Getting Started

Understanding MainWP

Dashboard

Sites

Users

Updates

Plugins

Themes

Content Operations

Clients

MCP Server

API Reference

Troubleshooting

Customization

Advanced

Resources

Route Matrix

Client Records

Client Fields

Representative Requests

Create a client

Create a client field

​Route Matrix

​Client Records

​Client Fields

​Representative Requests

​Create a client

​Create a client field

​Related Resources

Route Matrix

Client Records

Client Fields

Representative Requests

Create a client

Create a client field

Related Resources