Tasks
Tasks. parenttaskid nests one level only; taskseq is the per-project number.
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. |
| teamprojectid | integer | Reference to teamprojects, by id. Write either this or teamproject. |
| teamproject | string(30) | Code for the referenced teamproject, instead of the id. |
| teamprojectmilestoneid | integer | Teamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key. |
| parenttaskid | integer | Parenttaskid. Id only. |
| taskseq | integer | Per-project sequence number. Assigned automatically (MAX+1 for the project) when omitted on create; send one only to control it explicitly. |
| displayidread-only | string(30) | The task id shown everywhere in TPM (TPM-001-15). Derived by the model from the project code and taskseq on every save. Read-only - a sent value would be silently overwritten, so it is refused instead. |
| title | string(255) | Task title. |
| description | text | Description. Stored as text, no practical length limit. |
| teamprojectstatusid | integer | Reference to teamprojectstatuses, by id. Write either this or teamprojectstatus. |
| teamprojectstatus | string(100) | Code for the referenced teamprojectstatus, instead of the id. |
| priority | string | Priority. Labels are Teamprojecttask_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| startdate | string | Date work on the task starts. |
| duedate | string | Date payment is due. |
| estimatedhoursmoney | string(6dp) | Stored as decimal(18,6). |
| percentcomplete | integer | Progress, 0 to 100. |
| sortorder | integer | Display order. Lower sorts first. |
| requiresapproval | boolean | True routes task completion through an approval step. |
| approvaluserid | integer | Reference to genusers, by id. Write either this or approvaluser. |
| approvaluser | string(50) | Login name of the approver. Send this or approvaluserid, not both unless they agree. |
| approvalstatus | string | Approval workflow state. Labels are Teamprojecttask_model::$approvalstatuses; stored as an int and never exposed or accepted as one (D35). Only meaningful when requiresapproval is true. One of notrequested, pending, approved, rejected. |
| approvaldate | string | Date the completed task was approved. |
| approvalcomment | text | Approvalcomment. Stored as text, no practical length limit. |
| 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. |
| 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 |
|---|---|---|
| parenttaskid | integer | Parenttaskid. Id only. |
| taskseq | integer | Per-project sequence number. Assigned automatically (MAX+1 for the project) when omitted on create; send one only to control it explicitly. |
| displayidread-only | string(30) | The task id shown everywhere in TPM (TPM-001-15). Derived by the model from the project code and taskseq on every save. Read-only - a sent value would be silently overwritten, so it is refused instead. |
| title | string(255) | Task title. |
| description | text | Description. Stored as text, no practical length limit. |
| teamprojectstatusid | integer | Reference to teamprojectstatuses, by id. Write either this or teamprojectstatus. |
| teamprojectstatus | string(100) | Code for the referenced teamprojectstatus, instead of the id. |
| priority | string | Priority. Labels are Teamprojecttask_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| startdate | string | Date work on the task starts. |
| duedate | string | Date payment is due. |
| estimatedhoursmoney | string(6dp) | Stored as decimal(18,6). |
| percentcomplete | integer | Progress, 0 to 100. |
| sortorder | integer | Display order. Lower sorts first. |
| requiresapproval | boolean | True routes task completion through an approval step. |
| approvaluserid | integer | Reference to genusers, by id. Write either this or approvaluser. |
| approvaluser | string(50) | Login name of the approver. Send this or approvaluserid, not both unless they agree. |
| approvalstatus | string | Approval workflow state. Labels are Teamprojecttask_model::$approvalstatuses; stored as an int and never exposed or accepted as one (D35). Only meaningful when requiresapproval is true. One of notrequested, pending, approved, rejected. |
| approvaldate | string | Date the completed task was approved. |
| approvalcomment | text | Approvalcomment. Stored as text, no practical length limit. |
| 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. |
| externalid | string(100) | Your own key. Scoped to your company. |
| checklist | array of RefTeamprojectchecklistsCreate | Checklist items on this task, in order. |
| assignees | array of RefTeamprojecttaskassigneesCreate | Who the task is assigned to. |
| watchers | array of RefTeamprojecttaskwatchersCreate | Who gets notified about it. |
| tags | array of RefTeamprojecttasktagsCreate | Tags to attach. The tag itself must already exist. |
| comments | array of RefTeamprojectcommentsCreate | An opening comment or two. |
| teamprojectid | integer | Reference to teamprojects, by id. Write either this or teamproject. |
| teamproject | string(30) | Code for the referenced teamproject, instead of the id. |
| teamprojectmilestoneid | integer | Teamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojecttasks/batch' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '[ { "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/teamprojecttasks/batch'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ [ '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/teamprojecttasks/batch", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json=[ { "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/teamprojecttasks/batch', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify([ { 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 { 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/teamprojecttasks/batch") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
List tasks.
Requires scope projects:read.
| Name | In | Type | Notes |
|---|---|---|---|
| description | query | string | description. Partial match, case-insensitive. |
| title | 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. |
| teamprojectid | query | string | Filter to one . |
| 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/teamprojecttasks' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttasks'); 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/teamprojecttasks", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttasks', { 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/teamprojecttasks"); res.EnsureSuccessStatusCode();
Create.
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 |
|---|---|---|
| parenttaskid | integer | Parenttaskid. Id only. |
| taskseq | integer | Per-project sequence number. Assigned automatically (MAX+1 for the project) when omitted on create; send one only to control it explicitly. |
| displayidread-only | string(30) | The task id shown everywhere in TPM (TPM-001-15). Derived by the model from the project code and taskseq on every save. Read-only - a sent value would be silently overwritten, so it is refused instead. |
| title | string(255) | Task title. |
| description | text | Description. Stored as text, no practical length limit. |
| teamprojectstatusid | integer | Reference to teamprojectstatuses, by id. Write either this or teamprojectstatus. |
| teamprojectstatus | string(100) | Code for the referenced teamprojectstatus, instead of the id. |
| priority | string | Priority. Labels are Teamprojecttask_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| startdate | string | Date work on the task starts. |
| duedate | string | Date payment is due. |
| estimatedhoursmoney | string(6dp) | Stored as decimal(18,6). |
| percentcomplete | integer | Progress, 0 to 100. |
| sortorder | integer | Display order. Lower sorts first. |
| requiresapproval | boolean | True routes task completion through an approval step. |
| approvaluserid | integer | Reference to genusers, by id. Write either this or approvaluser. |
| approvaluser | string(50) | Login name of the approver. Send this or approvaluserid, not both unless they agree. |
| approvalstatus | string | Approval workflow state. Labels are Teamprojecttask_model::$approvalstatuses; stored as an int and never exposed or accepted as one (D35). Only meaningful when requiresapproval is true. One of notrequested, pending, approved, rejected. |
| approvaldate | string | Date the completed task was approved. |
| approvalcomment | text | Approvalcomment. Stored as text, no practical length limit. |
| 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. |
| externalid | string(100) | Your own key. Scoped to your company. |
| checklist | array of RefTeamprojectchecklistsCreate | Checklist items on this task, in order. |
| assignees | array of RefTeamprojecttaskassigneesCreate | Who the task is assigned to. |
| watchers | array of RefTeamprojecttaskwatchersCreate | Who gets notified about it. |
| tags | array of RefTeamprojecttasktagsCreate | Tags to attach. The tag itself must already exist. |
| comments | array of RefTeamprojectcommentsCreate | An opening comment or two. |
| teamprojectid | integer | Reference to teamprojects, by id. Write either this or teamproject. |
| teamproject | string(30) | Code for the referenced teamproject, instead of the id. |
| teamprojectmilestoneid | integer | Teamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key. |
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | A required field was missing. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojecttasks' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "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/teamprojecttasks'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ '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/teamprojecttasks", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "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/teamprojecttasks', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ 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 { 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/teamprojecttasks") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"priority": "low",
"approvalstatus": "notrequested"
}
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/teamprojecttasks/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttasks/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/teamprojecttasks/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttasks/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/teamprojecttasks/104"); res.EnsureSuccessStatusCode();
{
"priority": "low",
"approvalstatus": "notrequested"
}
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. |
| teamprojectid | integer | Reference to teamprojects, by id. Write either this or teamproject. |
| teamproject | string(30) | Code for the referenced teamproject, instead of the id. |
| teamprojectmilestoneid | integer | Teamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key. |
| parenttaskid | integer | Parenttaskid. Id only. |
| taskseq | integer | Per-project sequence number. Assigned automatically (MAX+1 for the project) when omitted on create; send one only to control it explicitly. |
| displayidread-only | string(30) | The task id shown everywhere in TPM (TPM-001-15). Derived by the model from the project code and taskseq on every save. Read-only - a sent value would be silently overwritten, so it is refused instead. |
| title | string(255) | Task title. |
| description | text | Description. Stored as text, no practical length limit. |
| teamprojectstatusid | integer | Reference to teamprojectstatuses, by id. Write either this or teamprojectstatus. |
| teamprojectstatus | string(100) | Code for the referenced teamprojectstatus, instead of the id. |
| priority | string | Priority. Labels are Teamprojecttask_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical. |
| startdate | string | Date work on the task starts. |
| duedate | string | Date payment is due. |
| estimatedhoursmoney | string(6dp) | Stored as decimal(18,6). |
| percentcomplete | integer | Progress, 0 to 100. |
| sortorder | integer | Display order. Lower sorts first. |
| requiresapproval | boolean | True routes task completion through an approval step. |
| approvaluserid | integer | Reference to genusers, by id. Write either this or approvaluser. |
| approvaluser | string(50) | Login name of the approver. Send this or approvaluserid, not both unless they agree. |
| approvalstatus | string | Approval workflow state. Labels are Teamprojecttask_model::$approvalstatuses; stored as an int and never exposed or accepted as one (D35). Only meaningful when requiresapproval is true. One of notrequested, pending, approved, rejected. |
| approvaldate | string | Date the completed task was approved. |
| approvalcomment | text | Approvalcomment. Stored as text, no practical length limit. |
| 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. |
| 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/teamprojecttasks/104' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "priority": "low", "approvalstatus": "notrequested" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttasks/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_POSTFIELDS => json_encode([ 'priority' => 'low', 'approvalstatus' => 'notrequested', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.patch( "https://acme.nolapro.com/!/api/v2/teamprojecttasks/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "priority": "low", "approvalstatus": "notrequested", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttasks/104', { method: 'PATCH', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ priority: "low", approvalstatus: "notrequested", }), } ); 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 { priority = "low", approvalstatus = "notrequested", }; var req = new HttpRequestMessage(HttpMethod.Patch, "https://acme.nolapro.com/!/api/v2/teamprojecttasks/104") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"priority": "low",
"approvalstatus": "notrequested"
}
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/teamprojecttasks/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttasks/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/teamprojecttasks/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttasks/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/teamprojecttasks/104"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"priority": "low",
"approvalstatus": "notrequested"
}
List files attached to a task.
The attachments on this task, newest first. Accepted filedefinitionid values: 68 (default 68). Metadata only - each file's bytes are at GET /attachments/{id}/content.
Requires scope projects:read.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The task id. |
| filedefinitionid | query | integer | Only files in this list. Accepted filedefinitionid values: 68 (default 68). |
| 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 task with that id in this company. |
curl \ 'https://acme.nolapro.com/!/api/v2/teamprojecttasks/104/attachments' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttasks/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/teamprojecttasks/104/attachments", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttasks/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/teamprojecttasks/104/attachments"); res.EnsureSuccessStatusCode();
Attach a file to a task.
multipart/form-data with one file part; see the AttachmentUpload schema for the other parts. Accepted filedefinitionid values: 68 (default 68). 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 task 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 task with that id in this company. |
| 409 | upload_limit_reached | This file list allows a fixed number of files on a task 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 task accepts, or the category does not exist in this company. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojecttasks/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/teamprojecttasks/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/teamprojecttasks/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/teamprojecttasks/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/teamprojecttasks/104/attachments") { Content = form }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();