awork icon

awork

Automate your workflows with the awork API

Overview

This node integrates with the awork API to automate workflows related to various resources, including users. Specifically, the "Get All Users" operation retrieves a list of user records from awork. This is useful for scenarios where you need to fetch and process user data in bulk, such as syncing user lists with other systems, generating reports, or managing user-related workflows.

Practical examples:

  • Fetching all users to update an internal directory.
  • Filtering users based on specific criteria (e.g., active status or role).
  • Ordering users by name or creation date for display or processing.

Properties

Name Meaning
Return All Whether to return all user results or only up to a specified limit. If false, the node will return a limited set.
Filter By Filter the user results by specific criteria using awork's filtering syntax. For example, duration gt 5. See awork filtering for details.
Order By Order the user results by a specific field and direction, e.g., FirstName asc. See awork ordering for details.

Output

The node outputs JSON data containing an array of user objects retrieved from the awork API. Each user object includes user-specific fields as defined by the awork API schema (such as user ID, name, email, etc.). The output can be used directly in subsequent workflow steps for further processing or integration.

No binary data output is produced by this operation.

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.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Authentication errors if the API key is missing or invalid.
    • Incorrect filter or order syntax causing API request failures.
    • Limits on returned data if "Return All" is false but no limit is explicitly set.
  • Error messages:

    • Unauthorized or 401 errors indicate problems with the API key; verify and update credentials.
    • 400 Bad Request errors may result from malformed filter or order strings; check syntax against awork documentation.
    • Timeout or network errors suggest connectivity issues; ensure n8n server can reach the awork API endpoint.

Links and References

Discussion