awork icon

awork

Automate your workflows with the awork API

Overview

The "Get All Companies" operation for the Company resource in this n8n node retrieves a list of companies from the awork API. This node is useful when you need to fetch company data for reporting, synchronization with other systems, or as part of automated workflows that require information about all or filtered sets of companies.

Practical examples:

  • Syncing company records from awork into a CRM or database.
  • Generating reports on all companies managed within awork.
  • Filtering and processing company data based on specific criteria (e.g., only active companies).

Properties

Display Name Type Description
Return All Boolean Whether to return all results or only up to a given limit. If set to false, the node may use a default limit.
Filter By String Filter the results by specific criteria. See awork filtering docs.
Order By String Order the results by a specific field and direction. See awork ordering docs.

Output

The output will be a JSON array where each item represents a company object as returned by the awork API. The structure typically includes fields such as:

[
  {
    "id": "string",
    "name": "string",
    "createdAt": "string",
    "updatedAt": "string",
    // ...other company-specific fields
  }
]

Note: The exact fields depend on the awork API's response for the company resource.

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

  • Invalid Credentials:
    Error message: "401 Unauthorized"
    Resolution: Ensure your awork API credentials are correct and have sufficient permissions.

  • Filtering/Ordering Errors:
    Error message: "400 Bad Request"
    Resolution: Double-check your filter and order by syntax. Refer to the awork filtering documentation and ordering documentation.

  • Large Result Sets:
    If "Return All" is enabled and there are many companies, the node may take longer to execute or hit API rate limits.

Links and References

Discussion