awork icon

awork

Automate your workflows with the awork API

Overview

This node retrieves information about a specific company from the awork API using its unique ID. It is useful in scenarios where you need to fetch detailed data for a particular company, such as integrating company profiles into automated workflows, synchronizing company records with other systems, or displaying company details in dashboards.

Example use cases:

  • Fetching company details to enrich CRM records.
  • Validating company existence before creating related entities.
  • Displaying company information in custom reports or notifications.

Properties

Display Name Type Description
Company ID String The ID of the company to retrieve. Required.
  • Company ID:
    • Type: String
    • Description: The unique identifier of the company you want to retrieve from awork.
    • Required: Yes
    • Placeholder: Enter the company ID

Output

The output will be a JSON object containing the details of the requested company. The structure typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "createdAt": "string (ISO date)",
  "updatedAt": "string (ISO date)",
  // ...other company-specific fields
}

Note: The exact fields depend on the awork API's response for a 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 credentials.

Troubleshooting

  • Invalid Company ID:
    If an incorrect or non-existent Company ID is provided, the node may return an error such as "404 Not Found" or "Company not found". Double-check the ID value.

  • Authentication Errors:
    If the API key is missing or invalid, errors like "401 Unauthorized" or "403 Forbidden" may occur. Ensure your awork API credentials are correctly set up in n8n.

  • Network Issues:
    Errors such as "ENOTFOUND" or "ECONNREFUSED" indicate connectivity problems between n8n and the awork API. Check your network connection and firewall settings.

Links and References

Discussion