awork icon

awork

Automate your workflows with the awork API

Actions26

Overview

This node interacts with the awork API to retrieve "Types of Work" associated with Project Tasks. It is useful for automating workflows that require fetching and processing different work types defined in your awork projects, such as categorizing tasks, generating reports, or integrating with other project management tools.

Example scenarios:

  • Listing all available types of work for a project to populate dropdowns in forms.
  • Filtering types of work based on custom criteria (e.g., only active types).
  • Sorting types of work for display or further automation steps.

Properties

Display Name Type Meaning
Return All Boolean Whether to return all results or limit the number of returned items. If set to false, only a default or user-specified limit will be applied.
Filter By String Filter the results by specific criteria. For example, you can filter by properties like duration or status. See awork filtering documentation for syntax and options.
Order By String Order the results by a specific field and direction (e.g., ascending or descending). See awork ordering documentation for details.

Output

The output is a list of objects, each representing a "Type of Work" associated with project tasks. Each object typically contains fields such as:

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "isBillable": true,
    "createdAt": "2023-01-01T00:00:00Z",
    ...
  }
]

The exact structure may include additional fields depending on the awork API response.

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 special environment variables are required beyond standard credential setup.

Troubleshooting

  • Invalid Credentials:
    Error message: "401 Unauthorized"
    Resolution: Ensure your awork API key is correct and has sufficient permissions.

  • Filtering/Ordering Errors:
    Error message: "400 Bad Request"
    Resolution: Double-check your filter and order by syntax. Refer to the awork filtering and ordering documentation.

  • No Results Returned:
    Possible causes: Filters too restrictive, or no types of work exist for the specified project/task.
    Resolution: Adjust filters or verify data exists in awork.

Links and References

Discussion