Lark Contacts icon

Lark Contacts

Lark Contacts Management

Actions38

Overview

This node, named "Lark Contacts," is designed to manage contacts within the Lark platform. Specifically, for the "Custom User Field" resource and the operation "Obtain Custom User Fields Of A Company," it retrieves custom user fields defined at the company level in Lark. This can be useful for scenarios where a user wants to programmatically access or synchronize custom metadata associated with users in their organization.

Practical examples include:

  • Integrating Lark user custom fields into an HR management system.
  • Automating reporting or analytics based on custom user attributes.
  • Syncing custom user data with other internal tools or CRMs.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: "Tenant Token" or "OAuth2".
Options Additional options for the request.
useCustomBody Boolean flag indicating whether to send a custom request body instead of the default.

Output

The node outputs JSON data representing the custom user fields retrieved from the company. The structure typically includes details about each custom field such as its identifier, name, type, and possibly values or configurations depending on the API response.

If binary data were involved (not indicated here), it would represent file attachments or similar content, but this node focuses on JSON data only.

Dependencies

  • Requires an active connection to the Lark Open Platform API.
  • Needs either a Tenant Token or OAuth2 authentication configured in n8n credentials.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions/scopes must be granted to the authentication method to read custom user fields.

Troubleshooting

  • Authentication errors: Ensure that the provided Tenant Token or OAuth2 credentials are valid and have the necessary scopes.
  • Permission denied: The authenticated user or token might lack permission to access custom user fields; verify roles and API permissions in Lark admin settings.
  • Empty or missing data: Confirm that custom user fields exist in the company and that the API endpoint is correctly called.
  • Use Custom Body option: If enabled incorrectly, the request may fail due to malformed body content. Use this option only if you need to override the default request payload.

Links and References

Discussion