Endpoint Clients

User Guide  /  API Documentation

Here, you will find out all information about Enterprised Cloud API Endpoint clients. Read out the complete API documentation to gather detailed knowledge about it.

List Clients

Request Method GET

API Endpoint /wp-json/ndpv/v1/clients

Response Status Code 200 OK

{
  "success": true,
  "data": {
    "result": [
      {
        "id": 3548,
        "type": "person",
        "first_name": "Mahbub Alam",
        "org_name": "",
        "email": "uniquegraph1@gmail.com",
        "web": "",
        "mobile": "+46 8 676 91 00",
        "country": "",
        "region": "",
        "address": "",
        "img": null,
        "date": "April 2, 2023"
      },
      {
        "id": 3546,
        "type": "person",
        "first_name": "Rachel Lee",
        "org_name": "",
        "email": "rlee@email.com",
        "web": "",
        "mobile": "",
        "country": "",
        "region": "",
        "address": "",
        "img": {
          "id": "3547",
          "src": "https://example.com/wp-content/uploads/2023/04/Aveter1-01.png"
        },
        "date": "April 2, 2023"
      }
    ],
    "total": 2
  }
}

Create Client

Request Method POST

API Endpoint /wp-json/ndpv/v1/clients

Request Payload application/json

• address: String OPTIONAL
• country: String OPTIONAL
• date: Date | false OPTIONAL
• email: String REQUIRED
• first_name: String REQUIRED
• id: null OPTIONAL
• mobile: String OPTIONAL
• org_id: null OPTIONAL
• org_name: String OPTIONAL
• person_id: null OPTIONAL
• region: String OPTIONAL
• web: String OPTIONAL

{
	"address": "",
	"country": "",
	"date": false,
	"email": "anguyen@email.com",
	"first_name": "Alex Nguyen",
	"id": null,
	"mobile": "",
	"org_id": null,
	"org_name": "",
	"person_id": null,
	"region": "",
	"web": ""
}

Response Status Code 200 OK

{
	"success": true
}

Read Client

Request Method GET

API Endpoint /wp-json/ndpv/v1/contacts/{CLIENT_ID}

Query String Parameters

• CLIENT_ID

Response Status Code 200 OK

{
  "success": true,
  "data": {
    "id": 3546,
    "ws_id": "7",
    "tab_id": "3546",
    "note": "",
    "project": 0,
    "deal": 0,
    "person": {
      "id": 3546,
      "first_name": "Rachel Lee",
      "org_id": "",
      "org_name": "",
      "email": "rlee@email.com",
      "mobile": "",
      "img": {
        "id": "3547",
        "src": "https://example.com/wp-content/uploads/2023/04/Aveter1-01.png"
      },
      "web": "",
      "country": "",
      "region": "",
      "address": ""
    },
    "org": null,
    "status_id": {
      "id": null,
      "label": null,
      "color": "#4a5568",
      "bg_color": "#E2E8F0",
      "type": false
    },
    "tags": [],
    "date": false
  }
}

Update Client

Request Method PUT

API Endpoint /wp-json/ndpv/v1/persons/{CLIENT_ID}

Query String Parameters

• CLIENT_ID

Request Payload application/json

• address: String OPTIONAL
• country: String OPTIONAL
• date: Date | false OPTIONAL
• email: String REQUIRED
• first_name: String REQUIRED
• id: Integer REQUIRED
• mobile: String OPTIONAL
• org_id: null OPTIONAL
• org_name: String OPTIONAL
• person_id: null OPTIONAL
• region: String OPTIONAL
• web: String OPTIONAL

{
	"address": "",
	"country": "",
	"email": "uniquegraph1@gmail.com",
	"first_name": "Mahbub Alam",
	"id": 3548,
	"img": null,
	"mobile": "+46 8 676 91 00",
	"org_id": "",
	"org_name": "",
	"region": "",
	"web": ""
}

Response Status Code 200 OK

{
	"success": true,
	"data": 3548
}

Delete Client

Request Method DELETE

API Endpoint /wp-json/ndpv/v1/contacts/{CLIENT_ID}

Query String Parameters

• CLIENT_ID

Response Status Code 200 OK

{
	"success": true,
	"data": [
		"3558"
	]
}