awork n8n integrationAutomate awork with n8n.

Creates a company in awork and returns its ID, which project operations reuse afterwards.

• Company Name: the name of the company, often {{ $json.companyName }} from the form or CRM node before it. Leave it empty and the node stops.
• Company Description: free text, a good home for the context a salesperson wrote down.
• Company Industry: the industry of the company, worth filling when reporting splits clients by sector.

Returns the companies of the workspace, one item per company, ready for a loop or a lookup.

• Return All: on, n8n walks every page of the API and brings back the full client list; off, Limit caps how many companies come out.
• Filter By: narrows the results on criteria, in the syntax awork documents for filtering.
• Order By: sorts on a field and a direction, so the list arrives ready to paste into a report.

Fetches one company from its identifier and returns its details as a single item.

• Company ID: the ID of the company to retrieve, not its name. It usually comes from a previous node as {{ $json.id }}, or from the Company ID carried by a project.

Lists the documents of the workspace without asking for anything, one item per document.

Retrieves a single document from its identifier, with its properties rather than its body.

• Document ID: the ID of the document, typically {{ $json.id }} passed down from a listing operation.

Pulls the HTML content of a document, which is what you need when the text itself has to travel.

• Document ID: the ID of the document whose body you want. Chain it after a listing operation so the workflow never hardcodes an identifier.

Scopes the document listing to a single document space instead of the whole workspace.

• Document Space ID: the ID of the document space to read. One space per department or per client keeps the volume manageable.

Lists what a given project holds in the way of documents, one item each.

• Project ID: the ID of the project, commonly {{ $json.projectId }} carried over from a trigger event on that project.

Writes a new document into awork, either in a document space or inside a project.

• Document Name: the name of the document, required.
• Document Space ID or Project ID: one of the two must be provided, and that choice decides where the page lives.
• Document Content: the HTML body of the document.
• Emoji: an emoji icon shown next to the document.
• Parent Document ID: another document in the same project or space, to nest this one under it.

Removes a document from awork, so keep this one behind a condition rather than on a raw list.

• Document ID: the ID of the document to delete. Read it first with a get operation if the workflow needs to log what disappeared.

Brings back the projects of the workspace, one item per project, which is the backbone of most reporting workflows.

• Return All: on, every page of projects comes through; off, Limit decides how many.
• Filter By: keeps only the projects matching your criteria, in the filtering syntax awork documents.
• Order By: sorts on a field and direction, useful to surface the oldest projects first.

Reads one project from its identifier and returns it as a single item.

• Project ID: the identifier of the project, rarely typed by hand. A trigger event on a task carries the project it belongs to, and that value goes straight in here.

Lists the project statuses defined in the workspace, which is how you learn the IDs the write operations expect.

• Return All: on for the complete set of statuses; off and Limit truncates the list.
• Filter By: restricts the statuses returned on criteria.
• Order By: sorts the statuses on a field and direction.

Narrows the status listing to a single project rather than the whole workspace.

• Project ID: the project whose statuses you want.
• Return All: on to page through them all, off to stop at Limit.
• Filter By: filters the returned statuses on criteria.
• Order By: sorts them on a field and a direction.

Creates a project by sending its details, and returns the project the rest of the workflow will hang off.

• Project Name: required, the only field the operation insists on.
• Company ID: attaches the project to a client account.
• Start Date and Due Date: the dates framing the engagement.
• Project Template ID: reuses an existing template instead of rebuilding the structure.
• Project Type ID, Project Status ID, Project Description: typing, starting state and context.

Reads the task statuses configured on a project, since each project can run its own board.

• Project ID: the project whose task statuses you are reading.
• Return All: on for every status, off to cap at Limit.
• Filter By and Order By: filter and sort the statuses on criteria and on a field with a direction.

Returns the task lists a project is organized into, which are the sections a task can belong to.

• Project ID: the project to inspect. Feed it from a trigger event or from a listing operation upstream.

Adds a project status to a project by sending its details, so the board matches how the team actually works.

• Project ID: the project receiving the new status.
• Status Name: required, what the status is called.
• Status Type: required, the category the status belongs to.

Switches a project to another status, which is the write counterpart of the status listing operations.

• Project ID: the project to move.
• Project Status ID: required, and it is an identifier, not the label shown in the interface. Resolve it first with the project status listing.

Adds a column to the task board of a project by sending the status details.

• Project ID: the project whose board grows.
• Status Name: required, the label of the column.
• Status Type: required, the category it falls under.
• Task Status Icon: required too, the icon shown on the status.

Creates a task list inside a project, the container tasks are grouped into.

• Project ID: where the list is created.
• Name: required, the name of this entity. Build it from data upstream, for instance a sprint label or a month.

Collects the comments left on a project, one item per comment, without any parameter to fill in.

Lists the tasks that belong to one project, one item per task. Most task workflows start from this read.

• Project ID: required, the ID of the project, often {{ $json.projectId }} carried over from an earlier node.
• Return All: on, n8n walks every page of tasks; off, Limit caps how many tasks come back.
• Filter By: keeps only the tasks that match a criterion, written in the awork filtering syntax.
• Order By: sorts on a field and a direction, a due date first for instance.

Pulls a single task back from its identifier, with the whole payload the rest of the workflow reads.

• Task ID: required, the ID of the task to retrieve, usually {{ $json.id }} taken from a task event.

Sends task details to awork and opens a new task inside a project.

• Project ID: required, the project that receives the task.
• Task Name: required, the name of the task.
• Task Description: the longer text, useful when the request comes from a form.
• Type of Work ID and Task Status ID: identifiers, not labels, so read them first with the listing operations.
• Due Date: a dateTime.
• Planned Duration: a number, counted in seconds.

Writes a value into a custom field of a task, for the data that has no standard field in awork.

• Task ID: required, the ID of the task to retrieve.
• Text Value: the text value of the custom field.
• Custom Field Definition ID: the ID of the custom field definition, which says which field gets written.

Attaches a tag to a task, which is the lightest way to classify work without touching its status.

• Task ID: required, the ID of the task to retrieve.
• Tag Name: the name of the tag, and it travels as text, so agree on a spelling before the workflow starts writing hundreds of them.

Moves a task to another status, the write counterpart of the task status listings.

• Task ID: required, the ID of the task to retrieve.
• Status ID: the ID of the status, an identifier rather than the column name, so fetch the task statuses of the project first.

Posts a comment on a task, so the automated part of the process leaves a trace where the team already reads.

• Task ID: required, the ID of the task to retrieve.
• Comment Message: the message of the comment, which can be built from the data of the previous node.

Gives a task to a person, which turns an unowned item into someone's work.

• Task ID: required, the ID of the task to retrieve.
• User ID: the ID of the user, resolved beforehand with the user listing operation, since an email address alone will not do.

Reads the types of work configured in the account, with their identifiers.

• Return All: on, every type of work comes back; off, Limit stops the list early.
• Filter By: restricts the types on a criterion in the awork filtering syntax.
• Order By: orders them on a field and a direction.

Reached from the task resource, this read brings back the task lists of a project with the paging controls the plain project listing does not offer.

• Project ID: required, the ID of the project.
• Return All: on for the full set of lists, off to stop at Limit.
• Filter By: narrows the lists on a criterion.
• Order By: sorts them on a field and a direction.

Adds a type of work to the account, the category tasks are labeled with.

• Name: required, the name of this entity.
• Icon: required too, the icon of this entity.
• Description: the description of this entity, worth filling when several teams share the same setup.

Files an existing task under a task list of a project, without creating anything new.

• Project ID: required, the ID of the project.
• Task ID: required, the ID of the task to retrieve.
• Task List ID: the task list to move the task to, which the task list listing gives you.

Collects the comments of a task from its identifier, one item per comment, with the author and the text of each message.

• Task ID: required, the ID of the task to retrieve.

Reads the users of the awork account, which is how a workflow turns a person into an identifier.

• Return All: on, every user comes back page after page; off, Limit stops the list.
• Filter By: keeps the users that match a criterion.
• Order By: sorts them on a field and a direction, by first name for instance.

Reads one user from an identifier and returns the profile stored in awork, name, status and the rest of the record.

• User ID: required, the ID of the user to retrieve, often the value a task assignment event carries.