Actions38
- User Actions
- Department Actions
- User Group Actions
- User Group Member Actions
- Unit Actions
- Workforce Type Actions
- Custom User Field Actions
- Contact Scope Actions
Overview
This node, named "Lark Contacts," is designed for managing contacts within the Lark platform. It provides functionality to interact with Lark's contact management APIs, enabling users to perform operations related to contacts such as retrieving or manipulating contact information.
Common scenarios where this node would be beneficial include:
- Synchronizing contact data between Lark and other systems.
- Automating updates or queries of organizational contacts.
- Integrating Lark contact information into workflows for communication or CRM purposes.
For example, a user might use this node to fetch all contacts from their Lark organization and then process or export that data elsewhere.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests. Options: Tenant Token (using a tenant-specific token), OAuth2 (using OAuth2 authentication flow). |
| Options | Additional options for the request: |
| - Use Custom Body | Boolean flag indicating whether to send a custom request body instead of the default one. |
Output
The node outputs JSON data representing the response from the Lark Contacts API. This typically includes contact details such as names, emails, phone numbers, and other relevant contact attributes depending on the specific operation performed.
If binary data were involved (e.g., profile pictures), it would be included in the binary output field, but based on the provided code and properties, the node primarily deals with JSON contact data.
Dependencies
- Requires an active connection to the Lark Open API endpoint at
https://open.larksuite.com/open-apis. - Requires either a Tenant Token or OAuth2 credentials for authentication.
- The node expects these credentials to be configured in n8n prior to execution.
Troubleshooting
- Authentication errors: Ensure that the correct authentication method is selected and that valid credentials are provided. Expired or invalid tokens will cause failures.
- API request failures: Network issues or incorrect API usage can result in errors. Verify connectivity and that any custom body used matches the API specification.
- Invalid custom body: If "Use Custom Body" is enabled, ensure the custom JSON body is correctly formatted and contains all required fields for the intended API call.