User Guide / API Documentation
In this documentation, you will get to know everything related to Enterprised Cloud API Endpoint Projects. Read out the complete documentation to learn this documentation.
List Projects
Request Method GET
API Endpoint /wp-json/ndpv/v1/projects?table_view=true
Response Status Code 200 OK
{
"success": true,
"data": {
"result": [
{
"id": "3550",
"title": "Webinar Funnel SaaS",
"budget": "",
"currency": "USD",
"start_date": "",
"due_date": "",
"note": "",
"desc": "Needs a website redesign and SEO optimization to improve their online presence and attract new clients.",
"status_id": {
"id": 57,
"label": "Done",
"color": "#0f1633",
"bg_color": "#4c6fff"
},
"tags": [
{
"id": 16,
"label": "Design"
},
{
"id": 17,
"label": "Development"
},
{
"id": 52,
"label": "UX"
}
],
"person": {
"id": 3548,
"first_name": "Mahbub Alam",
"org_id": "",
"org_name": "",
"email": "uniquegraph1@gmail.com",
"mobile": "+46 8 676 91 00",
"img": null
},
"org": {
"id": 3549,
"name": "Uniquegraph",
"person_id": "",
"first_name": "",
"email": "uniquegraph1@gmail.com",
"mobile": "+46 8 676 91 00",
"logo": null
},
"date": "April 2, 2023"
}
],
"total": 1,
"extra": {
"custom_field": []
}
}
}Create Project
Request Method POST
API Endpoint /wp-json/ndpv/v1/projects
Request Payload application/json
- budget : String
- currency : String (e.g “USD”, “BDT” etc)
- date : Date | false
- deal_id: String
- desc: String
- due_date: Date | null,
- email: String
- first_name: String
- id: null,
- mobile: String
- note: String
- org_id: null
- org_name: String
- person_id: null
- start_date: Date | null
- status_id: Integer
- tags : Array of String
- title : String
{
"budget": "5000",
"currency": "USD",
"date": false,
"deal_id": "",
"desc": "",
"due_date": null,
"email": "matthew.thomas@gmail.com",
"first_name": "Matthew Thomas",
"id": null,
"mobile": "",
"note": "",
"org_id": null,
"org_name": "",
"person_id": null,
"start_date": null,
"status_id": 59,
"tags": [
"16",
"17"
],
"title": "Web Development"
}Response Status Code 200 OK
{
"success": true,
"data": 3560
}Read Project
Request Method GET
API Endpoint /wp-json/ndpv/v1/projects/{PROJECT_ID}
Query String Parameters
- PROJECT_ID
Response Status Code 200 OK
{
"success": true,
"data": {
"id": 3550,
"ws_id": "7",
"tab_id": 3550,
"title": "Webinar Funnel SaaS",
"budget": 0,
"currency": "USD",
"start_date": "",
"due_date": "",
"note": "",
"desc": "Needs a website redesign and SEO optimization to improve their online presence and attract new clients.",
"custom_field": [],
"invoice": {
"total": 0,
"paid": 0,
"due": 0,
"number": 0
},
"status_id": {
"id": 57,
"label": "Done",
"color": "#0f1633",
"bg_color": "#4c6fff",
"type": ""
},
"tags": [
{
"id": 16,
"label": "Design"
},
{
"id": 17,
"label": "Development"
},
{
"id": 52,
"label": "UX"
}
],
"person": {
"id": 3548,
"first_name": "Mahbub Alam",
"org_id": "",
"org_name": "",
"email": "uniquegraph1@gmail.com",
"mobile": "+46 8 676 91 00",
"img": null,
"web": "",
"country": "",
"region": "",
"address": ""
},
"org": {
"id": 3549,
"name": "Uniquegraph",
"person_id": "",
"first_name": "",
"email": "uniquegraph1@gmail.com",
"mobile": "+46 8 676 91 00",
"logo": null,
"web": "",
"country": "",
"region": "",
"address": ""
},
"date": false
}
}Update Project
Request Method PUT
API Endpoint /wp-json/ndpv/v1/projects/{PROJECT_ID}
Query String Parameters
- PROJECT_ID
Request Payload application/json
- budget: Float
- currency: String (e.g “USD”, “BDT” etc)
- custom_field: Array
- date: Date | false,
- desc: Longtext
- due_date: Date | String,
- email: String
- first_name : String
- id: Integer
- invoice: Invoice Object
- mobile: String
- note: Longtext
- org: Org Object
- org_id: Integer
- org_name: String
- person: Person Object
- person_id: Integer
- start_date: Date | String
- status_id: Integer
- tab_id: Integer
- tags: Array of Integer
- title: String
- web: String
- ws_id: String
Invoice Object
- due: Float
- number: Integer
- paid: Float
- total: Float
Org Object
- address: String
- country: String
- email: String
- first_name: String
- id: Integer
- logo: null
- mobile: String
- name: String
- person_id: String
- region: String
- web: String
Person Object
- address: String
- country: String
- email: String
- first_name: String
- id: Integer
- img: String | null
- mobile: String
- org_id: String
- org_name: String
- region: String
- web: String
{
"budget": 0,
"currency": "USD",
"custom_field": [],
"date": false,
"desc": "Needs a website redesign and SEO optimization to improve their online presence and attract new clients.",
"due_date": "",
"email": "uniquegraph1@gmail.com",
"first_name": "Mahbub Alam",
"id": 3550,
"invoice": {
"due": 0,
"number": 0,
"paid": 0,
"total": 0
},
"mobile": "+46 8 676 91 00",
"note": "",
"org": {
"address": "",
"country": "",
"email": "uniquegraph1@gmail.com",
"first_name": "",
"id": 3549,
"logo": null,
"mobile": "+46 8 676 91 00",
"name": "Uniquegraph",
"person_id": "",
"region": "",
"web": ""
},
"org_id": 3549,
"org_name": "Uniquegraph",
"person": {
"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": ""
},
"person_id": 3548,
"start_date": "",
"status_id": 57,
"tab_id": 3550,
"tags": [
16,
17,
52
],
"title": "Webinar Funnel SaaS",
"web": "",
"ws_id": "7"
}Response Status Code 200 OK
{
"success": true,
"data": 3550
}Delete Project
Request Method DELETE
API Endpoint /wp-json/ndpv/v1/projects/{PROJECT_ID}
Query String Parameters
- PROJECT_ID
Response Status Code 200 OK
{
"success": true,
"data": [
"3550"
]
}