Projects

Projects. projectcode is the display id (TPM-001).

Licensed feature

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#

FieldTypeDescription
idread-onlyintegerNolaPro id.
namestring(200)Project name.
projectcodestring(20)Short code identifying the project.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled.
prioritystringPriority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical.
manageruseridintegerReference to genusers, by id. Write either this or manageruser.
manageruserstring(50)Login name of the project manager. Send this or manageruserid, not both unless they agree.
teamprojectcategoryidintegerReference to teamprojectcategories, by id. Write either this or teamprojectcategory.
teamprojectcategorystring(100)Code for the referenced teamprojectcategory, instead of the id.
colorstring(10)Display colour, hex.
startdatestringDate the project starts.
targetenddatestringDate the project is planned to finish.
actualenddatestringDate the project actually finished.
budgethoursmoneystring(6dp)Stored as decimal(18,6).
budgetamountmoneystring(4dp)Stored as decimal(19,4).
percentcompleteintegerProgress, 0 to 100.
customeridintegerReference to customers, by id. Write either this or customer.
customerstring(30)Code for the referenced customer, instead of the id.
vendoridintegerReference to vendors, by id. Write either this or vendor.
vendorstring(30)Code for the referenced vendor, instead of the id.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
lastchangedateread-onlystringLast modification. Drives modifiedsince.
worktypeidintegerReference to worktypes, by id. Write either this or worktype.
worktypestring(100)Code for the referenced worktype, instead of the id.
sortorderintegerDisplay order. Lower sorts first.
externalidstring(100)Your own key. Scoped to your company.

Endpoints#

POST/teamprojects/batch 207

Create many.

Requires scope projects:write.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes 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.
Body array
FieldTypeDescription
namestring(200)Project name.
projectcodestring(20)Short code identifying the project.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled.
prioritystringPriority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical.
manageruseridintegerReference to genusers, by id. Write either this or manageruser.
manageruserstring(50)Login name of the project manager. Send this or manageruserid, not both unless they agree.
teamprojectcategoryidintegerReference to teamprojectcategories, by id. Write either this or teamprojectcategory.
teamprojectcategorystring(100)Code for the referenced teamprojectcategory, instead of the id.
colorstring(10)Display colour, hex.
startdatestringDate the project starts.
targetenddatestringDate the project is planned to finish.
actualenddatestringDate the project actually finished.
budgethoursmoneystring(6dp)Stored as decimal(18,6).
budgetamountmoneystring(4dp)Stored as decimal(19,4).
percentcompleteintegerProgress, 0 to 100.
customeridintegerReference to customers, by id. Write either this or customer.
customerstring(30)Code for the referenced customer, instead of the id.
vendoridintegerReference to vendors, by id. Write either this or vendor.
vendorstring(30)Code for the referenced vendor, instead of the id.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
worktypeidintegerReference to worktypes, by id. Write either this or worktype.
worktypestring(100)Code for the referenced worktype, instead of the id.
sortorderintegerDisplay order. Lower sorts first.
externalidstring(100)Your own key. Scoped to your company.
milestonesarray of RefTeamprojectmilestonesCreateMilestones created under this project, in order. Each may carry its own tasks.
tasksarray of RefTeamprojecttasksCreateTasks 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
                    }
                ]
            }
        ]
    }
]'
GET/teamprojects 200403

List projects.

Requires scope projects:read.

Parameters
NameInTypeNotes
statusquerystringRestrict to one status.
customeridquerystringRestrict to one customerid.
vendoridquerystringRestrict to one vendorid.
namequerystringname. Partial match, case-insensitive.
descriptionquerystringdescription. Partial match, case-insensitive.
projectcodequerystringPartial match, case insensitive.
cancelquerystringDefaults to false. Pass true or any.
modifiedsincequerystringRFC 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.
externalidquerystringExact match on your own key.
includequerystringComma-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.
When it fails
StatusCodeMeaning
403insufficient_scopeToken lacks read scope.
curl \
  'https://acme.nolapro.com/!/api/v2/teamprojects' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/teamprojects 201400

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.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes 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.
Body
FieldTypeDescription
namestring(200)Project name.
projectcodestring(20)Short code identifying the project.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled.
prioritystringPriority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical.
manageruseridintegerReference to genusers, by id. Write either this or manageruser.
manageruserstring(50)Login name of the project manager. Send this or manageruserid, not both unless they agree.
teamprojectcategoryidintegerReference to teamprojectcategories, by id. Write either this or teamprojectcategory.
teamprojectcategorystring(100)Code for the referenced teamprojectcategory, instead of the id.
colorstring(10)Display colour, hex.
startdatestringDate the project starts.
targetenddatestringDate the project is planned to finish.
actualenddatestringDate the project actually finished.
budgethoursmoneystring(6dp)Stored as decimal(18,6).
budgetamountmoneystring(4dp)Stored as decimal(19,4).
percentcompleteintegerProgress, 0 to 100.
customeridintegerReference to customers, by id. Write either this or customer.
customerstring(30)Code for the referenced customer, instead of the id.
vendoridintegerReference to vendors, by id. Write either this or vendor.
vendorstring(30)Code for the referenced vendor, instead of the id.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
worktypeidintegerReference to worktypes, by id. Write either this or worktype.
worktypestring(100)Code for the referenced worktype, instead of the id.
sortorderintegerDisplay order. Lower sorts first.
externalidstring(100)Your own key. Scoped to your company.
milestonesarray of RefTeamprojectmilestonesCreateMilestones created under this project, in order. Each may carry its own tasks.
tasksarray of RefTeamprojecttasksCreateTasks created directly on the project, with no milestone. Use the tasks inside a milestone for tasks that belong to one.
When it fails
StatusCodeMeaning
400invalid_requestA 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
                }
            ]
        }
    ]
}'
Response 201
{
    "status": "notstarted",
    "priority": "low"
}
GET/teamprojects/{id} 200404

Retrieve one record.

Requires scope projects:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
includequerystringComma-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.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl \
  'https://acme.nolapro.com/!/api/v2/teamprojects/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "status": "notstarted",
    "priority": "low"
}
PATCH/teamprojects/{id} 200404

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.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes 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.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
namestring(200)Project name.
projectcodestring(20)Short code identifying the project.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamproject_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of notstarted, inprogress, onhold, completed, cancelled.
prioritystringPriority. Labels are Teamproject_model::$priorities; stored as an int and never exposed or accepted as one (D35). One of low, normal, high, critical.
manageruseridintegerReference to genusers, by id. Write either this or manageruser.
manageruserstring(50)Login name of the project manager. Send this or manageruserid, not both unless they agree.
teamprojectcategoryidintegerReference to teamprojectcategories, by id. Write either this or teamprojectcategory.
teamprojectcategorystring(100)Code for the referenced teamprojectcategory, instead of the id.
colorstring(10)Display colour, hex.
startdatestringDate the project starts.
targetenddatestringDate the project is planned to finish.
actualenddatestringDate the project actually finished.
budgethoursmoneystring(6dp)Stored as decimal(18,6).
budgetamountmoneystring(4dp)Stored as decimal(19,4).
percentcompleteintegerProgress, 0 to 100.
customeridintegerReference to customers, by id. Write either this or customer.
customerstring(30)Code for the referenced customer, instead of the id.
vendoridintegerReference to vendors, by id. Write either this or vendor.
vendorstring(30)Code for the referenced vendor, instead of the id.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
lastchangedateread-onlystringLast modification. Drives modifiedsince.
worktypeidintegerReference to worktypes, by id. Write either this or worktype.
worktypestring(100)Code for the referenced worktype, instead of the id.
sortorderintegerDisplay order. Lower sorts first.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
404not_foundNo 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"
}'
Response 200
{
    "status": "notstarted",
    "priority": "low"
}
DELETE/teamprojects/{id} 200404

Cancel.

Requires scope projects:cancel.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes 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.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/teamprojects/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "status": "notstarted",
    "priority": "low"
}
GET/teamprojects/{id}/attachments 200404

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.

Parameters
NameInTypeNotes
idrequiredpathintegerThe project id.
filedefinitionidqueryintegerOnly files in this list. Accepted filedefinitionid values: 67 (default 67).
filecategoryidqueryintegerOnly files filed under this category.
filenamequerystringPartial match on the file name, case insensitive.
When it fails
StatusCodeMeaning
404not_foundNo project with that id in this company.
curl \
  'https://acme.nolapro.com/!/api/v2/teamprojects/104/attachments' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/teamprojects/{id}/attachments 201400404409413415422

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.

Parameters
NameInTypeNotes
idrequiredpathintegerThe project id.
Idempotency-KeyheaderstringMakes 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.
Body multipart/form-data
FieldTypeDescription
filerequiredstringThe 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.
filenamestring(255)Overrides the part's file name.
notestextFree text shown beside the file.
filedefinitionidintegerOnly when the parent accepts more than one list. Anything the parent does not accept is 422 unknown_value naming the accepted ids.
filecategoryidintegerCategory by id.
filecategorystring(255)Category by name. Sent with filecategoryid and disagreeing is 422 conflicting_reference.
When it fails
StatusCodeMeaning
400unknown_parameterA form field that is not on the AttachmentUpload schema.
400invalid_typefiledefinitionid or filecategoryid that is not an integer.
404not_foundNo project with that id in this company.
409upload_limit_reachedThis file list allows a fixed number of files on a project and it is full. Remove one first.
413payload_too_largeThe file is over the cap. The body names the limit that applied.
415multipart_requiredThe body was not multipart/form-data.
422unknown_valuefiledefinitionid 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'