awork icon

awork

Automate your workflows with the awork API

Overview

This node integrates with the awork API to retrieve data about companies. Specifically, the "Get All Companies" operation fetches a list of companies from the awork system. This is useful for automating workflows that require company information, such as syncing company data with other systems, generating reports, or managing company-related tasks.

Practical examples:

  • Automatically retrieving all companies to update a CRM system.
  • Filtering companies based on specific criteria to generate targeted marketing lists.
  • Ordering companies by name or creation date for display in dashboards.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit (true = all results, false = limited).
Filter By Filter the results by specific criteria using awork's filtering syntax (e.g., duration gt 5). See https://developers.awork.com/filtering for details.
Order By Order the results by a specific field and direction (e.g., FirstName asc). See https://developers.awork.com/ordering for details.

Output

The node outputs JSON data containing an array of company objects retrieved from the awork API. Each object represents a company with its associated fields as defined by the awork API schema.

If binary data were supported, it would typically represent file attachments or documents related to companies, but this node focuses on JSON data output only.

Dependencies

  • Requires an API key credential for authenticating with the awork API.
  • The node uses the base URL https://api.awork.com for all requests.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Incorrect filter or order syntax may result in API errors or empty responses.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • "Bad Request" errors often mean the filter or order parameters are malformed; consult the awork filtering and ordering documentation.
    • Timeout or network errors suggest connectivity issues; check your internet connection and firewall settings.

Links and References

Discussion