Overview
The node "Lark Company" is designed to interact with Lark's company management APIs, specifically for managing and obtaining information related to a tenant's company. In the context of the "Tenant" resource and the "Obtain Company Information" operation, this node fetches detailed information about the company associated with the authenticated tenant.
This node is beneficial in scenarios where you need to integrate Lark company data into workflows, such as syncing company details with other systems, auditing company info, or automating administrative tasks based on company attributes.
Practical examples:
- Automatically retrieving company profile information to display in an internal dashboard.
- Using company data to customize notifications or workflows depending on company attributes.
- Integrating company info into HR or CRM systems for unified data management.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate API requests. Options: Tenant Token, OAuth2 |
| Options | Additional optional settings: - Use Custom Body (boolean): Whether to send a custom request body instead of default |
Output
The node outputs JSON data containing the company information retrieved from Lark's API. The structure typically includes fields describing the company's profile, such as company name, ID, domain, and other metadata provided by Lark.
If binary data were involved, it would be summarized here, but this node focuses on JSON responses representing company details.
Dependencies
- Requires access to Lark's Open API endpoints at
https://open.larksuite.com/open-apis. - Needs authentication credentials configured in n8n, either via a Tenant Token or OAuth2 token.
- Proper permissions/scopes must be granted to the credentials to allow reading company information.
Troubleshooting
- Authentication errors: Ensure that the provided Tenant Token or OAuth2 credentials are valid and have not expired.
- Permission denied: Verify that the credentials have sufficient permissions to access company information.
- Network issues: Confirm that the n8n instance can reach Lark's API endpoint without firewall or proxy restrictions.
- Invalid custom body: If using the "Use Custom Body" option, ensure the custom JSON body is correctly formatted according to Lark's API specification.
Links and References
- Lark Open Platform Documentation
- Lark Company Management API Reference (example link; adjust based on actual API docs)