OpenProject
App · 9 actions
Plan and track work in OpenProject: create, update and find work packages, comment, log and find time, and start a workflow when a work package is created or changes.
Actions
| Action | What it does |
|---|---|
| Add comment | Comment on a work package, as its Activity tab does. |
| Create work package | Create a work package in a project, such as a task from a form, a bug from an alert or a feature request from an email. |
| Delete work package | Delete a work package for good, with its children, comments and the time logged on it. |
| Find time entries | Find the time logged in a project or on a work package, by someone or between two dates, newest first, with the hours added up. |
| Find work packages | Find work packages by project, status, type, assignee, priority, words or when they changed. |
| Get work package | Get a work package's details, and its comments and changes if you ask for them. |
| List projects | List every project the connected user can see, with its identifier. |
| Log time | Log hours spent on a work package. |
| Update work package | Change a work package's status, assignee, priority, % complete, dates or other fields, with a comment saying why. |
Add comment
Comment on a work package, as its Activity tab does. Markdown works.
Inputs
- Work package
work_packagetextRequired - The work package's number, such as 482, or its link.
- Comment
commenttextRequired - What to write.
Outputs
activity_idnumber- The comment's entry in the work package's activity
authortext- Who it's from: the connected user
commenttext- The comment added
created_attext- When the entry was made (ISO 8601)
linktext- A link to the work package's activity in OpenProject
work_package_idnumber- The work package's number
Example output
{
"activity_id": 1908,
"author": "Jane Doe",
"comment": "The customer confirmed the fix works.",
"created_at": "2026-11-05T15:20:00Z",
"link": "https://yourcompany.openproject.com/work_packages/482/activity",
"work_package_id": 482
}Create work package
Create a work package in a project, such as a task from a form, a bug from an alert or a feature request from an email.
Inputs
- Project
projecttextRequired - The project to add it to.
- Subject
subjecttextRequired - Its one-line title.
- Type
typetext - What kind of work package, such as Task, Bug or Feature. Leave blank for the project's default type.
- Description
descriptiontext - The details, in Markdown.
- Assignee
assigneetext - Who will do it: a project member's name, username or ID, or me.
- Accountable
accountabletext - Who is accountable for it: a project member's name, username or ID, or me.
- Priority
prioritytext - How urgent it is. Leave blank for OpenProject's default.
- Start date
start_datedate - When work starts.
- Finish date
due_datedate - When it's due.
- Work
estimated_hoursnumber - How many hours the work should take, such as 4 or 1.5.From 0 to 1000.
- Parent
parenttext - Make it a child of this work package: its number or link.
- Custom fields
custom_fieldsobject - Values for the project's custom fields, by the field's name as OpenProject shows it, such as Customer: Acme Ltd. A list field takes its choice's name.
Outputs
accountabletext- Who is accountable for it; empty if nobody
accountable_idnumber- The accountable person's ID; 0 if nobody
assigneetext- Who it's assigned to; empty if nobody
assignee_idnumber- The assignee's ID; 0 if nobody
authortext- Who created it
author_idnumber- The ID of who created it
created_attext- When it was created (ISO 8601)
custom_fieldsobject- Its custom fields' values, by field name
descriptiontext- Its description, in Markdown
due_datetext- Its finish date (YYYY-MM-DD); empty if none
estimated_hoursnumber- The work estimated for it, in hours; 0 if none
idnumber- The work package's number
is_closedtrue/false- Whether its status counts as closed
linktext- A link to it in OpenProject
lock_versionnumber- Its version, which goes up each time it changes
parent_idnumber- Its parent work package's number; 0 if none
percentage_donenumber- How far done it is (% Complete), from 0 to 100
prioritytext- Its priority, such as Normal or High
projecttext- The project it's in
project_idnumber- The project's ID
remaining_hoursnumber- The work remaining, in hours; 0 if none
spent_hoursnumber- The hours logged on it
start_datetext- Its start date (YYYY-MM-DD); empty if none
statustext- Its status, such as New or In progress
subjecttext- Its one-line title
typetext- Its type, such as Task, Bug or Feature
updated_attext- When it last changed (ISO 8601)
Example output
{
"accountable": "",
"accountable_id": 0,
"assignee": "Sam Patel",
"assignee_id": 6,
"author": "Jane Doe",
"author_id": 5,
"created_at": "2026-11-05T09:12:44Z",
"custom_fields": {
"Customer": "Acme Ltd"
},
"description": "Submitting the form on /contact shows a spinner and nothing arrives.",
"due_date": "2026-11-12",
"estimated_hours": 4.0,
"id": 482,
"is_closed": false,
"link": "https://yourcompany.openproject.com/work_packages/482",
"lock_version": 3,
"parent_id": 0,
"percentage_done": 30,
"priority": "High",
"project": "Website",
"project_id": 3,
"remaining_hours": 2.8,
"spent_hours": 1.5,
"start_date": "2026-11-05",
"status": "In progress",
"subject": "Contact form does not send",
"type": "Bug",
"updated_at": "2026-11-05T14:03:10Z"
}Delete work package
Delete a work package for good, with its children, comments and the time logged on it. It can't be restored.
Inputs
- Work package
work_packagetextRequired - The work package's number, such as 482, or its link.
Outputs
deletedtrue/false- True once deleted
idnumber- The deleted work package's number
Example output
{
"deleted": true,
"id": 482
}Find time entries
Find the time logged in a project or on a work package, by someone or between two dates, newest first, with the hours added up.
Inputs
- Project
projecttext - Only this project. Leave blank for every project.
- Work package
work_packagetext - Only time logged on this work package: its number or link.
- Spent by
usertext - Only time this person logged, or me.
- From
from_datedate - Only time spent on or after this day.
- To
to_datedate - Only time spent on or before this day.
- How many
limitnumber - The most to list. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many are listed
hoursnumber- The hours of those listed, added up
time_entrieslist- The time entries, newest first
totalnumber- How many match in all
Example output
{
"count": 1,
"hours": 1.5,
"time_entries": [
{
"activity": "Development",
"comment": "Fixed the mail settings",
"created_at": "2026-11-05T16:00:00Z",
"hours": 1.5,
"id": 2201,
"project": "Website",
"project_id": 3,
"spent_on": "2026-11-05",
"user": "Sam Patel",
"user_id": 6,
"work_package": "Contact form does not send",
"work_package_id": 482
}
],
"total": 1
}Find work packages
Find work packages by project, status, type, assignee, priority, words or when they changed. Most recently updated first, unless you pick another order.
Inputs
- Project
projecttext - Only this project. Leave blank for every project.
- Status
statustext - Any open status, any closed status, any status, or one status. Leave blank for open work packages.
- Type
typetext - Only this type.
- Assignee
assigneetext - Only work packages assigned to this person, me, or none for those assigned to nobody.
- Priority
prioritytext - Only this priority.
- Words
texttext - Only work packages with these words in their subject, description or comments.
- Updated since
updated_sincedate and time - Only work packages changed at or after this time.
- Created since
created_sincedate and time - Only work packages created at or after this time.
- Order
sorttext - Which come first.One of:
updated(Most recently updated),created(Most recently created),priority(Highest priority),due(Soonest due). Default:updated. - How many
limitnumber - The most to list. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many are listed
totalnumber- How many match in all
work_packageslist- The work packages found
Example output
{
"count": 1,
"total": 1,
"work_packages": [
{
"accountable": "",
"accountable_id": 0,
"assignee": "Sam Patel",
"assignee_id": 6,
"author": "Jane Doe",
"author_id": 5,
"created_at": "2026-11-05T09:12:44Z",
"custom_fields": {
"Customer": "Acme Ltd"
},
"description": "Submitting the form on /contact shows a spinner and nothing arrives.",
"due_date": "2026-11-12",
"estimated_hours": 4.0,
"id": 482,
"is_closed": false,
"link": "https://yourcompany.openproject.com/work_packages/482",
"lock_version": 3,
"parent_id": 0,
"percentage_done": 30,
"priority": "High",
"project": "Website",
"project_id": 3,
"remaining_hours": 2.8,
"spent_hours": 1.5,
"start_date": "2026-11-05",
"status": "In progress",
"subject": "Contact form does not send",
"type": "Bug",
"updated_at": "2026-11-05T14:03:10Z"
}
]
}Get work package
Get a work package's details, and its comments and changes if you ask for them.
Inputs
- Work package
work_packagetextRequired - The work package's number, such as 482, or its link.
- Include activity
include_activitytrue/false - Also get its comments and changes, oldest first (the newest 50).
Outputs
accountabletext- Who is accountable for it; empty if nobody
accountable_idnumber- The accountable person's ID; 0 if nobody
activitylist- Its comments and changes, oldest first (the newest 50); empty unless asked for
assigneetext- Who it's assigned to; empty if nobody
assignee_idnumber- The assignee's ID; 0 if nobody
authortext- Who created it
author_idnumber- The ID of who created it
created_attext- When it was created (ISO 8601)
custom_fieldsobject- Its custom fields' values, by field name
descriptiontext- Its description, in Markdown
due_datetext- Its finish date (YYYY-MM-DD); empty if none
estimated_hoursnumber- The work estimated for it, in hours; 0 if none
idnumber- The work package's number
is_closedtrue/false- Whether its status counts as closed
linktext- A link to it in OpenProject
lock_versionnumber- Its version, which goes up each time it changes
parent_idnumber- Its parent work package's number; 0 if none
percentage_donenumber- How far done it is (% Complete), from 0 to 100
prioritytext- Its priority, such as Normal or High
projecttext- The project it's in
project_idnumber- The project's ID
remaining_hoursnumber- The work remaining, in hours; 0 if none
spent_hoursnumber- The hours logged on it
start_datetext- Its start date (YYYY-MM-DD); empty if none
statustext- Its status, such as New or In progress
subjecttext- Its one-line title
typetext- Its type, such as Task, Bug or Feature
updated_attext- When it last changed (ISO 8601)
Example output
{
"accountable": "",
"accountable_id": 0,
"activity": [
{
"changes": [
"Status changed from New to In progress",
"% Complete changed from 0% to 30%"
],
"comment": "Reproduced on Safari; looking at the mail settings.",
"created_at": "2026-11-05T14:03:10Z",
"id": 1907,
"user": "Sam Patel",
"user_id": 6
}
],
"assignee": "Sam Patel",
"assignee_id": 6,
"author": "Jane Doe",
"author_id": 5,
"created_at": "2026-11-05T09:12:44Z",
"custom_fields": {
"Customer": "Acme Ltd"
},
"description": "Submitting the form on /contact shows a spinner and nothing arrives.",
"due_date": "2026-11-12",
"estimated_hours": 4.0,
"id": 482,
"is_closed": false,
"link": "https://yourcompany.openproject.com/work_packages/482",
"lock_version": 3,
"parent_id": 0,
"percentage_done": 30,
"priority": "High",
"project": "Website",
"project_id": 3,
"remaining_hours": 2.8,
"spent_hours": 1.5,
"start_date": "2026-11-05",
"status": "In progress",
"subject": "Contact form does not send",
"type": "Bug",
"updated_at": "2026-11-05T14:03:10Z"
}List projects
List every project the connected user can see, with its identifier.
Inputs
None.
Outputs
countnumber- How many
projectslist- The projects
Example output
{
"count": 1,
"projects": [
{
"active": true,
"created_at": "2026-01-14T10:00:00Z",
"description": "The company website",
"id": 3,
"identifier": "website",
"link": "https://yourcompany.openproject.com/projects/website",
"name": "Website",
"parent": "",
"parent_id": 0,
"public": false
}
]
}Log time
Log hours spent on a work package.
Inputs
- Work package
work_packagetextRequired - The work package's number, such as 482, or its link.
- Hours
hoursnumberRequired - How long, in hours, such as 1.5.From 0.01 to 1000.
- Activity
activitytext - What kind of work, such as Development. Leave blank for none.
- Date
spent_ondate - The day it was spent. Leave blank for today.
- Comment
commenttext - What was done, in a line.
- Spent by
usertext - Log it for someone else. Needs permission to log time for other users. Leave blank for the connected user.
Outputs
activitytext- What kind of work, such as Development; empty if not given
commenttext- What was done
created_attext- When it was logged (ISO 8601)
hoursnumber- How many hours
idnumber- The time entry's ID
projecttext- The project the time was spent in
project_idnumber- The project's ID
spent_ontext- The day it was spent (YYYY-MM-DD)
usertext- Who spent it
user_idnumber- Their ID
work_packagetext- The work package's title
work_package_idnumber- The work package's number
Example output
{
"activity": "Development",
"comment": "Fixed the mail settings",
"created_at": "2026-11-05T16:00:00Z",
"hours": 1.5,
"id": 2201,
"project": "Website",
"project_id": 3,
"spent_on": "2026-11-05",
"user": "Sam Patel",
"user_id": 6,
"work_package": "Contact form does not send",
"work_package_id": 482
}Update work package
Change a work package's status, assignee, priority, % complete, dates or other fields, with a comment saying why. A change someone made at the same moment is kept.
Inputs
- Work package
work_packagetextRequired - The work package's number, such as 482, or its link.
- Status
statustext - Move it to this status, such as In progress or Closed. Leave blank to keep it.
- Assignee
assigneetext - Who will do it: a name, username or ID, me, or none to leave it with nobody. Leave blank to keep it.
- Priority
prioritytext - A new priority. Leave blank to keep it.
- % Complete
percentage_donenumber - How far done it is, from 0 to 100. Leave blank to keep it.From 0 to 100.
- Comment
commenttext - A comment to add with the change, saying why. Markdown works.
- Subject
subjecttext - A new one-line title. Leave blank to keep it.
- Description
descriptiontext - A new description, in Markdown, replacing the old one. Leave blank to keep it.
- Type
typetext - Change it to this type. Leave blank to keep it.
- Accountable
accountabletext - Who is accountable for it: a name, username or ID, me, or none. Leave blank to keep it.
- Start date
start_datedate - A new start date. Leave blank to keep it.
- Finish date
due_datedate - A new finish date. Leave blank to keep it.
- Work
estimated_hoursnumber - How many hours the work should take, such as 4 or 1.5.From 0 to 1000.
- Custom fields
custom_fieldsobject - Values for the project's custom fields, by the field's name as OpenProject shows it, such as Customer: Acme Ltd. A list field takes its choice's name.
Outputs
accountabletext- Who is accountable for it; empty if nobody
accountable_idnumber- The accountable person's ID; 0 if nobody
assigneetext- Who it's assigned to; empty if nobody
assignee_idnumber- The assignee's ID; 0 if nobody
authortext- Who created it
author_idnumber- The ID of who created it
created_attext- When it was created (ISO 8601)
custom_fieldsobject- Its custom fields' values, by field name
descriptiontext- Its description, in Markdown
due_datetext- Its finish date (YYYY-MM-DD); empty if none
estimated_hoursnumber- The work estimated for it, in hours; 0 if none
idnumber- The work package's number
is_closedtrue/false- Whether its status counts as closed
linktext- A link to it in OpenProject
lock_versionnumber- Its version, which goes up each time it changes
parent_idnumber- Its parent work package's number; 0 if none
percentage_donenumber- How far done it is (% Complete), from 0 to 100
prioritytext- Its priority, such as Normal or High
projecttext- The project it's in
project_idnumber- The project's ID
remaining_hoursnumber- The work remaining, in hours; 0 if none
spent_hoursnumber- The hours logged on it
start_datetext- Its start date (YYYY-MM-DD); empty if none
statustext- Its status, such as New or In progress
subjecttext- Its one-line title
typetext- Its type, such as Task, Bug or Feature
updated_attext- When it last changed (ISO 8601)
Example output
{
"accountable": "",
"accountable_id": 0,
"assignee": "Sam Patel",
"assignee_id": 6,
"author": "Jane Doe",
"author_id": 5,
"created_at": "2026-11-05T09:12:44Z",
"custom_fields": {
"Customer": "Acme Ltd"
},
"description": "Submitting the form on /contact shows a spinner and nothing arrives.",
"due_date": "2026-11-12",
"estimated_hours": 4.0,
"id": 482,
"is_closed": false,
"link": "https://yourcompany.openproject.com/work_packages/482",
"lock_version": 3,
"parent_id": 0,
"percentage_done": 30,
"priority": "High",
"project": "Website",
"project_id": 3,
"remaining_hours": 2.8,
"spent_hours": 1.5,
"start_date": "2026-11-05",
"status": "In progress",
"subject": "Contact form does not send",
"type": "Bug",
"updated_at": "2026-11-05T14:03:10Z"
}