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 to manage contacts within the Lark platform. Specifically, for the "Workforce Type" resource and the "Query The Workforce Type" operation, it allows users to query workforce type information from Lark's contact management system. This can be useful in scenarios where an organization wants to retrieve structured data about different workforce categories or types defined in their Lark workspace.
Practical examples include:
- Fetching workforce type details to synchronize with an internal HR system.
- Using workforce type data to segment employees for targeted communications or workflows.
- Automating reporting based on workforce classifications stored in Lark.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests. Options: "Tenant Token" or "OAuth2". |
| Options | Additional options for the query: |
| - Use Custom Body | Boolean flag indicating whether to send a custom request body instead of default query. |
Output
The node outputs JSON data representing the queried workforce type information retrieved from Lark's API. The structure typically includes details about workforce types such as IDs, names, descriptions, and other metadata as provided by the Lark Contacts API.
If binary data were involved (not indicated here), it would represent files or attachments related to workforce types, but this node focuses on JSON data output only.
Dependencies
- Requires access to Lark's Open APIs.
- Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
- The base URL for API requests is
https://open.larksuite.com/open-apis. - Proper permissions/scopes must be granted to the API credentials to query workforce type data.
Troubleshooting
- Authentication errors: Ensure that the selected authentication method is correctly configured with valid credentials and necessary permissions.
- API request failures: Check network connectivity and verify that the Lark API endpoint is reachable.
- Invalid response or empty data: Confirm that the workforce types exist in the Lark workspace and that the authenticated user has access rights.
- Using custom body option: If enabled, ensure the custom body format matches the API specification to avoid request errors.
Links and References
- Lark Open Platform Documentation
- Lark Contacts API Reference (for detailed API parameters and responses)