awork icon

awork

Automate your workflows with the awork API

Overview

This node integrates with the awork API to retrieve project data. Specifically, the "Get All Projects" operation fetches multiple projects from awork, allowing users to automate workflows that require bulk access to project information. This is useful for scenarios such as reporting on all active projects, syncing project lists with other tools, or filtering projects based on specific criteria.

For example, a user might want to get all projects where the duration is greater than 5 days or order projects by their start date ascendingly.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Filter By Filter the results by specific criteria. For example, filtering projects where duration is greater than 5. See https://developers.awork.com/filtering for syntax details.
Order By Order the results by a specific field and direction, e.g., ordering projects by name ascending. See https://developers.awork.com/ordering for syntax details.

Output

The node outputs JSON data representing an array of project objects retrieved from the awork API. Each project object contains fields describing the project's attributes (such as ID, name, status, dates, etc.). The exact structure depends on the awork API response for projects.

If binary data were involved (not in this case), it would be summarized accordingly, but here the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the awork API.
  • The node uses the base URL https://api.awork.com and expects JSON responses.
  • No additional external dependencies are required beyond the API key credential setup in n8n.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication errors.
    • Incorrect filter or order syntax may result in API errors; users should verify filter/order strings against the awork API documentation.
    • Network connectivity issues can prevent successful API calls.
  • Error messages:

    • Authentication failures typically indicate invalid credentials; recheck and update the API key.
    • API errors related to filtering or ordering usually include messages about invalid query parameters; consult the linked documentation to correct these.
    • Timeout or network errors suggest checking internet connection or firewall settings.

Links and References

Discussion