awork icon

awork

Automate your workflows with the awork API

Overview

This node interacts with the awork API to retrieve task lists associated with a specific project. It is designed for scenarios where you need to automate the extraction of all task lists belonging to a given project, such as reporting, synchronization with other tools, or workflow automation in project management processes.

Example use cases:

  • Fetching all task lists for a project to generate progress reports.
  • Integrating awork project task lists into dashboards or external systems.
  • Automating follow-up actions based on the structure of a project's tasks.

Properties

Display Name Type Meaning
Project ID String The unique identifier of the project whose task lists you want to retrieve. (Required)
Return All Boolean Whether to return all available results or limit the number of returned items.
Filter By String Criteria to filter the results (e.g., by duration, status). See awork filtering docs for syntax.
Order By String Field and direction to order the results (e.g., "FirstName asc"). See awork ordering docs for syntax.

Output

The output will be a JSON array where each item represents a task list belonging to the specified project. Each object typically contains details about the task list, such as:

[
  {
    "id": "string",            // Unique identifier of the task list
    "name": "string",          // Name of the task list
    "projectId": "string",     // Associated project ID
    "createdAt": "string",     // Creation timestamp
    "updatedAt": "string",     // Last update timestamp
    // ...other fields depending on awork API response
  }
]

Note: The exact fields depend on the awork API's response schema.

Dependencies

  • External Service: Requires access to the awork API.
  • API Key: You must configure valid awork API credentials in n8n under the name aworkApi.
  • n8n Configuration: No additional configuration required beyond credential setup.

Troubleshooting

Common Issues:

  • Invalid Project ID: If the provided Project ID does not exist or is incorrect, the node may return an error or an empty result set.
  • Missing Credentials: If awork API credentials are not configured or are invalid, authentication errors will occur.
  • Filter/Order Syntax Errors: Incorrect syntax in "Filter By" or "Order By" properties can cause API errors. Refer to the awork documentation for correct usage.

Error Messages & Resolutions:

  • "401 Unauthorized": Check your awork API credentials in n8n.
  • "404 Not Found": Verify that the Project ID is correct and exists in your awork account.
  • "400 Bad Request": Review your filter or order expressions for typos or unsupported fields.

Links and References

Discussion