awork icon

awork

Automate your workflows with the awork API
Join our community

Actions36

Overview

This node interacts with the awork API to retrieve a list of companies. It supports fetching all companies or a limited number based on user-defined criteria. Users can filter the results by specific criteria, order the results by a chosen field and direction, and configure request options such as batching, SSL certificate validation, proxy settings, and request timeout. This node is useful for automating workflows that require company data retrieval from awork, such as syncing company information with other systems or generating reports.

Use Case Examples

  1. Retrieve all companies without limit.
  2. Fetch companies filtered by specific criteria, e.g., companies with more than 5 employees.
  3. Get companies ordered by their name in ascending order.

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 using awork API filtering syntax.
Order By Order the results by a specific field and direction using awork API ordering syntax.
Request Options Additional request options including batching, SSL certificate validation, proxy, and timeout settings.

Output

JSON

  • id - Unique identifier of the company.
  • name - Name of the company.
  • createdAt - Timestamp when the company was created.
  • updatedAt - Timestamp when the company was last updated.
  • otherCompanyFields - Additional fields returned by the awork API for the company.

Dependencies

  • awork API
  • an API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access company data.
  • If filtering or ordering syntax is incorrect, the API may return errors; refer to https://developers.awork.com/filtering and https://developers.awork.com/ordering for correct usage.
  • Network issues or incorrect proxy settings can cause request failures; verify proxy configuration if used.
  • If SSL certificate validation fails and 'Ignore SSL Issues' is not enabled, requests will be blocked; enable this option only if you trust the network environment.

Links

Discussion