Projects
Projects. projectcode is the display id (TPM-001).
This resource needs the teamproject feature active on the install you are calling. Without that every endpoint here answers 403 with feature_not_licensed - that is a licensing answer, not a permissions one, so check the company's features before the token's scopes.
The object#
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| name | string(200) | Project name. |
| projectcode | string(20) | Short code identifying the project. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled. |
| priority | string | Priority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| manageruserid | integer | Reference to genusers, by id. Write either this or manageruser. |
| manageruser | string(50) | Login name of the project manager. Send this or manageruserid, not both unless they agree. |
| teamprojectcategoryid | integer | Reference to teamprojectcategories, by id. Write either this or teamprojectcategory. |
| teamprojectcategory | string(100) | Code for the referenced teamprojectcategory, instead of the id. |
| color | string(10) | Display colour, hex. |
| startdate | string | Date the project starts. |
| targetenddate | string | Date the project is planned to finish. |
| actualenddate | string | Date the project actually finished. |
| budgethoursmoney | string(6dp) | Stored as decimal(18,6). |
| budgetamountmoney | string(4dp) | Stored as decimal(19,4). |
| percentcomplete | integer | Progress, 0 to 100. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| entrydateread-only | string | When the record was created. |
| lastchangedateread-only | string | Last modification. Drives modifiedsince. |
| worktypeid | integer | Reference to worktypes, by id. Write either this or worktype. |
| worktype | string(100) | Code for the referenced worktype, instead of the id. |
| sortorder | integer | Display order. Lower sorts first. |
| externalid | string(100) | Your own key. Scoped to your company. |
Endpoints#
Create many.
Requires scope projects:write.
| Name | In | Type | Notes |
|---|---|---|---|
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| name | string(200) | Project name. |
| projectcode | string(20) | Short code identifying the project. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled. |
| priority | string | Priority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| manageruserid | integer | Reference to genusers, by id. Write either this or manageruser. |
| manageruser | string(50) | Login name of the project manager. Send this or manageruserid, not both unless they agree. |
| teamprojectcategoryid | integer | Reference to teamprojectcategories, by id. Write either this or teamprojectcategory. |
| teamprojectcategory | string(100) | Code for the referenced teamprojectcategory, instead of the id. |
| color | string(10) | Display colour, hex. |
| startdate | string | Date the project starts. |
| targetenddate | string | Date the project is planned to finish. |
| actualenddate | string | Date the project actually finished. |
| budgethoursmoney | string(6dp) | Stored as decimal(18,6). |
| budgetamountmoney | string(4dp) | Stored as decimal(19,4). |
| percentcomplete | integer | Progress, 0 to 100. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| entrydateread-only | string | When the record was created. |
| worktypeid | integer | Reference to worktypes, by id. Write either this or worktype. |
| worktype | string(100) | Code for the referenced worktype, instead of the id. |
| sortorder | integer | Display order. Lower sorts first. |
| externalid | string(100) | Your own key. Scoped to your company. |
| milestones | array of RefTeamprojectmilestonesCreate | Milestones created under this project, in order. Each may carry its own tasks. |
| tasks | array of RefTeamprojecttasksCreate | Tasks created directly on the project, with no milestone. Use the tasks inside a milestone for tasks that belong to one. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojects/batch' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '[ { "status": "notstarted", "priority": "low", "milestones": [ { "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": false, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104 } ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104 } ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104 } ] } ] } ], "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": false, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104 } ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104 } ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104 } ] } ] } ]'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects/batch'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ [ 'status' => 'notstarted', 'priority' => 'low', 'milestones' => [ [ 'status' => 'pending', 'tasks' => [ [ 'priority' => 'low', 'approvalstatus' => 'notrequested', 'checklist' => [ [ 'title' => 'Example title', 'iscomplete' => false, 'sortorder' => 1, 'parentchecklistid' => 104, 'teamprojecttaskid' => 104, ], ], 'assignees' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'watchers' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'tags' => [ [ 'teamprojecttagid' => 104, 'teamprojecttag' => 'Example teamprojecttag', 'teamprojecttaskid' => 104, ], ], 'comments' => [ [ 'parentcommentid' => 104, 'comment' => 'Example comment', 'teamprojecttaskid' => 104, ], ], ], ], ], ], 'tasks' => [ [ 'priority' => 'low', 'approvalstatus' => 'notrequested', 'checklist' => [ [ 'title' => 'Example title', 'iscomplete' => false, 'sortorder' => 1, 'parentchecklistid' => 104, 'teamprojecttaskid' => 104, ], ], 'assignees' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'watchers' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'tags' => [ [ 'teamprojecttagid' => 104, 'teamprojecttag' => 'Example teamprojecttag', 'teamprojecttaskid' => 104, ], ], 'comments' => [ [ 'parentcommentid' => 104, 'comment' => 'Example comment', 'teamprojecttaskid' => 104, ], ], ], ], ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/teamprojects/batch", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json=[ { "status": "notstarted", "priority": "low", "milestones": [ { "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": False, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104, }, ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104, }, ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104, }, ], }, ], }, ], "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": False, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104, }, ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104, }, ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104, }, ], }, ], }, ], ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojects/batch', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify([ { status: "notstarted", priority: "low", milestones: [ { status: "pending", tasks: [ { priority: "low", approvalstatus: "notrequested", checklist: [ { title: "Example title", iscomplete: false, sortorder: 1, parentchecklistid: 104, teamprojecttaskid: 104, }, ], assignees: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], watchers: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], tags: [ { teamprojecttagid: 104, teamprojecttag: "Example teamprojecttag", teamprojecttaskid: 104, }, ], comments: [ { parentcommentid: 104, comment: "Example comment", teamprojecttaskid: 104, }, ], }, ], }, ], tasks: [ { priority: "low", approvalstatus: "notrequested", checklist: [ { title: "Example title", iscomplete: false, sortorder: 1, parentchecklistid: 104, teamprojecttaskid: 104, }, ], assignees: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], watchers: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], tags: [ { teamprojecttagid: 104, teamprojecttag: "Example teamprojecttag", teamprojecttaskid: 104, }, ], comments: [ { parentcommentid: 104, comment: "Example comment", teamprojecttaskid: 104, }, ], }, ], }, ]), } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var body = new[] { new { status = "notstarted", priority = "low", milestones = new[] { new { status = "pending", tasks = new[] { new { priority = "low", approvalstatus = "notrequested", checklist = new[] { new { title = "Example title", iscomplete = false, sortorder = 1, parentchecklistid = 104, teamprojecttaskid = 104, }, }, assignees = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, watchers = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, tags = new[] { new { teamprojecttagid = 104, teamprojecttag = "Example teamprojecttag", teamprojecttaskid = 104, }, }, comments = new[] { new { parentcommentid = 104, comment = "Example comment", teamprojecttaskid = 104, }, }, }, }, }, }, tasks = new[] { new { priority = "low", approvalstatus = "notrequested", checklist = new[] { new { title = "Example title", iscomplete = false, sortorder = 1, parentchecklistid = 104, teamprojecttaskid = 104, }, }, assignees = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, watchers = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, tags = new[] { new { teamprojecttagid = 104, teamprojecttag = "Example teamprojecttag", teamprojecttaskid = 104, }, }, comments = new[] { new { parentcommentid = 104, comment = "Example comment", teamprojecttaskid = 104, }, }, }, }, }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/teamprojects/batch") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
List projects.
Requires scope projects:read.
| Name | In | Type | Notes |
|---|---|---|---|
| status | query | string | Restrict to one status. |
| customerid | query | string | Restrict to one customerid. |
| vendorid | query | string | Restrict to one vendorid. |
| name | query | string | name. Partial match, case-insensitive. |
| description | query | string | description. Partial match, case-insensitive. |
| projectcode | query | string | Partial match, case insensitive. |
| cancel | query | string | Defaults to false. Pass true or any. |
| modifiedsince | query | string | RFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so cancel defaults to any rather than false when this is used. The response carries _meta.synced_through; store it and send it back next time. |
| externalid | query | string | Exact match on your own key. |
| include | query | string | Comma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions. |
| Status | Code | Meaning |
|---|---|---|
| 403 | insufficient_scope | Token lacks read scope. |
curl \ 'https://acme.nolapro.com/!/api/v2/teamprojects' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.get( "https://acme.nolapro.com/!/api/v2/teamprojects", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojects', { method: 'GET', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var res = await http.GetAsync( "https://acme.nolapro.com/!/api/v2/teamprojects"); res.EnsureSuccessStatusCode();
Create.
Creates a project. Optionally send milestones and tasks in the same request: the project is created first, then each child is attached to the new id, all inside one transaction. The response echoes the tree in the order you sent it, with real ids, so you can map your input positions.
Requires scope projects:write.
| Name | In | Type | Notes |
|---|---|---|---|
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| name | string(200) | Project name. |
| projectcode | string(20) | Short code identifying the project. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled. |
| priority | string | Priority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| manageruserid | integer | Reference to genusers, by id. Write either this or manageruser. |
| manageruser | string(50) | Login name of the project manager. Send this or manageruserid, not both unless they agree. |
| teamprojectcategoryid | integer | Reference to teamprojectcategories, by id. Write either this or teamprojectcategory. |
| teamprojectcategory | string(100) | Code for the referenced teamprojectcategory, instead of the id. |
| color | string(10) | Display colour, hex. |
| startdate | string | Date the project starts. |
| targetenddate | string | Date the project is planned to finish. |
| actualenddate | string | Date the project actually finished. |
| budgethoursmoney | string(6dp) | Stored as decimal(18,6). |
| budgetamountmoney | string(4dp) | Stored as decimal(19,4). |
| percentcomplete | integer | Progress, 0 to 100. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| entrydateread-only | string | When the record was created. |
| worktypeid | integer | Reference to worktypes, by id. Write either this or worktype. |
| worktype | string(100) | Code for the referenced worktype, instead of the id. |
| sortorder | integer | Display order. Lower sorts first. |
| externalid | string(100) | Your own key. Scoped to your company. |
| milestones | array of RefTeamprojectmilestonesCreate | Milestones created under this project, in order. Each may carry its own tasks. |
| tasks | array of RefTeamprojecttasksCreate | Tasks created directly on the project, with no milestone. Use the tasks inside a milestone for tasks that belong to one. |
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | A required field was missing. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojects' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "status": "notstarted", "priority": "low", "milestones": [ { "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": false, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104 } ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104 } ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104 } ] } ] } ], "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": false, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104 } ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104 } ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104 } ] } ] }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ 'status' => 'notstarted', 'priority' => 'low', 'milestones' => [ [ 'status' => 'pending', 'tasks' => [ [ 'priority' => 'low', 'approvalstatus' => 'notrequested', 'checklist' => [ [ 'title' => 'Example title', 'iscomplete' => false, 'sortorder' => 1, 'parentchecklistid' => 104, 'teamprojecttaskid' => 104, ], ], 'assignees' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'watchers' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'tags' => [ [ 'teamprojecttagid' => 104, 'teamprojecttag' => 'Example teamprojecttag', 'teamprojecttaskid' => 104, ], ], 'comments' => [ [ 'parentcommentid' => 104, 'comment' => 'Example comment', 'teamprojecttaskid' => 104, ], ], ], ], ], ], 'tasks' => [ [ 'priority' => 'low', 'approvalstatus' => 'notrequested', 'checklist' => [ [ 'title' => 'Example title', 'iscomplete' => false, 'sortorder' => 1, 'parentchecklistid' => 104, 'teamprojecttaskid' => 104, ], ], 'assignees' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'watchers' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'tags' => [ [ 'teamprojecttagid' => 104, 'teamprojecttag' => 'Example teamprojecttag', 'teamprojecttaskid' => 104, ], ], 'comments' => [ [ 'parentcommentid' => 104, 'comment' => 'Example comment', 'teamprojecttaskid' => 104, ], ], ], ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/teamprojects", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "status": "notstarted", "priority": "low", "milestones": [ { "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": False, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104, }, ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104, }, ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104, }, ], }, ], }, ], "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": False, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104, }, ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104, }, ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104, }, ], }, ], }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojects', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ status: "notstarted", priority: "low", milestones: [ { status: "pending", tasks: [ { priority: "low", approvalstatus: "notrequested", checklist: [ { title: "Example title", iscomplete: false, sortorder: 1, parentchecklistid: 104, teamprojecttaskid: 104, }, ], assignees: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], watchers: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], tags: [ { teamprojecttagid: 104, teamprojecttag: "Example teamprojecttag", teamprojecttaskid: 104, }, ], comments: [ { parentcommentid: 104, comment: "Example comment", teamprojecttaskid: 104, }, ], }, ], }, ], tasks: [ { priority: "low", approvalstatus: "notrequested", checklist: [ { title: "Example title", iscomplete: false, sortorder: 1, parentchecklistid: 104, teamprojecttaskid: 104, }, ], assignees: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], watchers: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], tags: [ { teamprojecttagid: 104, teamprojecttag: "Example teamprojecttag", teamprojecttaskid: 104, }, ], comments: [ { parentcommentid: 104, comment: "Example comment", teamprojecttaskid: 104, }, ], }, ], }), } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var body = new { status = "notstarted", priority = "low", milestones = new[] { new { status = "pending", tasks = new[] { new { priority = "low", approvalstatus = "notrequested", checklist = new[] { new { title = "Example title", iscomplete = false, sortorder = 1, parentchecklistid = 104, teamprojecttaskid = 104, }, }, assignees = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, watchers = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, tags = new[] { new { teamprojecttagid = 104, teamprojecttag = "Example teamprojecttag", teamprojecttaskid = 104, }, }, comments = new[] { new { parentcommentid = 104, comment = "Example comment", teamprojecttaskid = 104, }, }, }, }, }, }, tasks = new[] { new { priority = "low", approvalstatus = "notrequested", checklist = new[] { new { title = "Example title", iscomplete = false, sortorder = 1, parentchecklistid = 104, teamprojecttaskid = 104, }, }, assignees = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, watchers = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, tags = new[] { new { teamprojecttagid = 104, teamprojecttag = "Example teamprojecttag", teamprojecttaskid = 104, }, }, comments = new[] { new { parentcommentid = 104, comment = "Example comment", teamprojecttaskid = 104, }, }, }, }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/teamprojects") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"status": "notstarted",
"priority": "low"
}
Retrieve one record.
Requires scope projects:read.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The record id. |
| include | query | string | Comma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No record with that id. |
curl \ 'https://acme.nolapro.com/!/api/v2/teamprojects/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.get( "https://acme.nolapro.com/!/api/v2/teamprojects/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojects/104', { method: 'GET', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var res = await http.GetAsync( "https://acme.nolapro.com/!/api/v2/teamprojects/104"); res.EnsureSuccessStatusCode();
{
"status": "notstarted",
"priority": "low"
}
Update.
Only the fields you send change. Children cannot be sent here - milestones and tasks are create-only (see Conventions). Use the child resource to add, change or cancel one.
Requires scope projects:write.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The record id. |
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| name | string(200) | Project name. |
| projectcode | string(20) | Short code identifying the project. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled. |
| priority | string | Priority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| manageruserid | integer | Reference to genusers, by id. Write either this or manageruser. |
| manageruser | string(50) | Login name of the project manager. Send this or manageruserid, not both unless they agree. |
| teamprojectcategoryid | integer | Reference to teamprojectcategories, by id. Write either this or teamprojectcategory. |
| teamprojectcategory | string(100) | Code for the referenced teamprojectcategory, instead of the id. |
| color | string(10) | Display colour, hex. |
| startdate | string | Date the project starts. |
| targetenddate | string | Date the project is planned to finish. |
| actualenddate | string | Date the project actually finished. |
| budgethoursmoney | string(6dp) | Stored as decimal(18,6). |
| budgetamountmoney | string(4dp) | Stored as decimal(19,4). |
| percentcomplete | integer | Progress, 0 to 100. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| vendorid | integer | Reference to vendors, by id. Write either this or vendor. |
| vendor | string(30) | Code for the referenced vendor, instead of the id. |
| cancel | boolean | Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable. |
| entrydateread-only | string | When the record was created. |
| lastchangedateread-only | string | Last modification. Drives modifiedsince. |
| worktypeid | integer | Reference to worktypes, by id. Write either this or worktype. |
| worktype | string(100) | Code for the referenced worktype, instead of the id. |
| sortorder | integer | Display order. Lower sorts first. |
| externalid | string(100) | Your own key. Scoped to your company. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No record with that id. |
curl -X PATCH \ 'https://acme.nolapro.com/!/api/v2/teamprojects/104' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "status": "notstarted", "priority": "low" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_POSTFIELDS => json_encode([ 'status' => 'notstarted', 'priority' => 'low', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.patch( "https://acme.nolapro.com/!/api/v2/teamprojects/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "status": "notstarted", "priority": "low", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojects/104', { method: 'PATCH', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ status: "notstarted", priority: "low", }), } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var body = new { status = "notstarted", priority = "low", }; var req = new HttpRequestMessage(HttpMethod.Patch, "https://acme.nolapro.com/!/api/v2/teamprojects/104") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"status": "notstarted",
"priority": "low"
}
Cancel.
Requires scope projects:cancel.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The record id. |
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No record with that id. |
curl -X DELETE \ 'https://acme.nolapro.com/!/api/v2/teamprojects/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'DELETE', ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.delete( "https://acme.nolapro.com/!/api/v2/teamprojects/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojects/104', { method: 'DELETE', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var req = new HttpRequestMessage(HttpMethod.Delete, "https://acme.nolapro.com/!/api/v2/teamprojects/104"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"status": "notstarted",
"priority": "low"
}
List files attached to a project.
The attachments on this project, newest first. Accepted filedefinitionid values: 67 (default 67). Metadata only - each file's bytes are at GET /attachments/{id}/content.
Requires scope projects:read.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The project id. |
| filedefinitionid | query | integer | Only files in this list. Accepted filedefinitionid values: 67 (default 67). |
| filecategoryid | query | integer | Only files filed under this category. |
| filename | query | string | Partial match on the file name, case insensitive. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No project with that id in this company. |
curl \ 'https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.get( "https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments', { method: 'GET', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var res = await http.GetAsync( "https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments"); res.EnsureSuccessStatusCode();
Attach a file to a project.
multipart/form-data with one file part; see the AttachmentUpload schema for the other parts. Accepted filedefinitionid values: 67 (default 67). Answers 201 with the attachment's metadata and Location: /attachments/{id}. Check _meta.warnings for datatype_truncated and stored_under_parent_company.
Requires scope projects:write.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The project id. |
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| filerequired | string | The file. Exactly one part named file; a second one, or file[], is 400 invalid_request so an idempotent retry can never half-succeed. Empty is refused. Over the cap (the smaller of APIV2_MAX_UPLOAD_BYTES, 64 MB by default, and PHP's upload_max_filesize / post_max_size) is 413 payload_too_large naming the limit that applied. |
| filename | string(255) | Overrides the part's file name. |
| notes | text | Free text shown beside the file. |
| filedefinitionid | integer | Only when the parent accepts more than one list. Anything the parent does not accept is 422 unknown_value naming the accepted ids. |
| filecategoryid | integer | Category by id. |
| filecategory | string(255) | Category by name. Sent with filecategoryid and disagreeing is 422 conflicting_reference. |
| Status | Code | Meaning |
|---|---|---|
| 400 | unknown_parameter | A form field that is not on the AttachmentUpload schema. |
| 400 | invalid_type | filedefinitionid or filecategoryid that is not an integer. |
| 404 | not_found | No project with that id in this company. |
| 409 | upload_limit_reached | This file list allows a fixed number of files on a project and it is full. Remove one first. |
| 413 | payload_too_large | The file is over the cap. The body names the limit that applied. |
| 415 | multipart_required | The body was not multipart/form-data. |
| 422 | unknown_value | filedefinitionid is not one this project accepts, or the category does not exist in this company. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Idempotency-Key: your-unique-key' \ -F 'file=@grant-letter-signed.pdf' \ -F 'filename=grant-letter-signed.pdf' \ -F 'notes=Signed copy received 21 Sep' \ -F 'filedefinitionid=8' \ -F 'filecategory=Receipts'
$fields = [ 'filename' => 'grant-letter-signed.pdf', 'notes' => 'Signed copy received 21 Sep', 'filedefinitionid' => '8', 'filecategory' => 'Receipts', ]; $fields['file'] = new CURLFile('grant-letter-signed.pdf'); $ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN'), 'Idempotency-Key: your-unique-key'], CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => $fields, ]); $res = json_decode(curl_exec($ch), true);
import os, requests with open("grant-letter-signed.pdf", "rb") as fh: r = requests.post( "https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}", "Idempotency-Key": "your-unique-key"}, files={"file": fh}, data={ "filename": "grant-letter-signed.pdf", "notes": "Signed copy received 21 Sep", "filedefinitionid": "8", "filecategory": "Receipts", }, ) r.raise_for_status()
import { openAsBlob } from 'node:fs';
const form = new FormData();
form.append('file', await openAsBlob('grant-letter-signed.pdf'), 'grant-letter-signed.pdf');
form.append('filename', "grant-letter-signed.pdf");
form.append('notes', "Signed copy received 21 Sep");
form.append('filedefinitionid', "8");
form.append('filecategory', "Receipts");
const res = await fetch(
'https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments',
{
method: 'POST',
headers: { Authorization: `Bearer ${process.env.NP_TOKEN}`, 'Idempotency-Key': 'your-unique-key' },
body: form,
}
);
const data = await res.json();
var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); using var form = new MultipartFormDataContent(); form.Add(new StreamContent(File.OpenRead("grant-letter-signed.pdf")), "file", "grant-letter-signed.pdf"); form.Add(new StringContent("grant-letter-signed.pdf"), "filename"); form.Add(new StringContent("Signed copy received 21 Sep"), "notes"); form.Add(new StringContent("8"), "filedefinitionid"); form.Add(new StringContent("Receipts"), "filecategory"); var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments") { Content = form }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();