awork

Overview

The Get All Users operation for the "User" resource in this n8n node retrieves a list of users from the awork API. This operation is useful for automating tasks that require access to user data, such as synchronizing user lists with other systems, generating reports, or managing permissions and roles within your workflows.

Practical examples:

• Fetching all users to send notifications or emails.
• Exporting user data for HR or analytics purposes.
• Filtering users based on specific criteria (e.g., only active users).

Properties

Output

The output is a JSON array where each item represents a user object retrieved from the awork API. The structure typically includes fields such as:

[
  {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    // ...other user properties
  }
]

Note: The exact fields depend on the awork API's user object definition.

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, authentication errors will occur. Ensure your awork API credentials are correctly configured in n8n.
• Incorrect Filter/Order Syntax: Using invalid syntax in "Filter By" or "Order By" may result in errors from the awork API. Refer to the official documentation for correct usage.
• Large Result Sets: If "Return All" is enabled and there are many users, performance may be affected or API rate limits may be reached.

Error Messages:

• 401 Unauthorized: Check your API credentials.
• 400 Bad Request: Review your filter or order parameters for typos or unsupported fields.
• 429 Too Many Requests: You have hit the API rate limit; try again later or reduce request frequency.

Links and References

• awork API Documentation
• Filtering in awork
• Ordering in awork
• n8n Documentation