awork icon

awork

Automate your workflows with the awork API

Overview

The "Get All Projects" operation for the Project resource in this n8n node allows users to retrieve a list of projects from the awork API. This is useful for automating workflows that require access to project data, such as reporting, synchronization with other tools, or triggering actions based on project information.

Common scenarios:

  • Fetching all projects to display in dashboards.
  • Filtering and sorting projects for custom reports.
  • Integrating project lists into other business processes.

Practical example:
Automatically pull all active projects every morning and send a summary email to your team.


Properties

Display Name Type Description
Return All Boolean Whether to return all results or only up to a given limit.
Filter By String Filter the results by specific criteria. See awork filtering docs for details. Example: duration gt 5
Order By String Order the results by a specific field and direction. See awork ordering docs for details. Example: FirstName asc

Output

The output will be an array of JSON objects, each representing a project. Each object typically contains fields such as:

{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "createdAt": "string (ISO date)",
  "updatedAt": "string (ISO date)",
  // ...other project-specific fields
}

Note: The exact structure depends on the awork API's response for the project list endpoint.


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 setting up credentials.

Troubleshooting

Common issues:

  • Invalid Credentials: If the API key is missing or incorrect, you may receive authentication errors. Ensure your aworkApi credentials are set up correctly in n8n.
  • Filter/Order Syntax Errors: Incorrect syntax in "Filter By" or "Order By" properties can cause API errors. Refer to the awork filtering documentation and ordering documentation for correct usage.
  • Large Result Sets: If "Return All" is enabled and there are many projects, performance may be affected. Consider using filters or limits if possible.

Error messages you might encounter:

  • "401 Unauthorized": Check your API credentials.
  • "400 Bad Request": Likely due to invalid filter or order syntax.
  • "429 Too Many Requests": You have hit the API rate limit; try again later.

Links and References

Discussion