Use Lark with Sokko.
Connect Lark and tell Sokko what to do. It runs the actions you ask for and reacts to what happens. No workflows, no code.
Works with 1,000+ tools · No code required
Actions
Everything Sokko can do in Lark
Every Lark action Sokko can run. Ask for one in a sentence and it's done.
Identify the ticket in the file
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Identify the ticket in the file. Japan driving license identification interface, supporting JPG/JPEG/PNG/BMP four file types of one-time recognition. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Agree to the approval task
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Agree to the approval task. Perform a consent action for a single approval task. Once agreed, the approval process flows to the next approver. Execution applies the approval decision immediately and may notify or advance the workflow for others; this action cannot undo that decision.
CC approval instance
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. CC approval instance. Calling this interface copies the current approval instance to the specified user. The copied user can view the approval instance details. For example, the approval instance is viewed in the Lark client's Workbench > Approval > Approval Center > CC Me list. Execution discloses the approval instance to the CC recipient immediately and may notify them; this action cannot undo that disclosure.
Get approval task list
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Get approval task list. Query the task list by setting task grouping, approval definition code, etc. Task grouping includes pending approval, completed approval, etc
Get the list of user initiated approvals
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Get the list of user initiated approvals. Get the list of approvals initiated by the user as the user, which is consistent with Approval - > Approval Center - > Initiated in Lark
Obtain details of an approval instance (user-scoped)
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Obtain details of an approval instance (user-scoped). Obtain the detailed information of the specified approval instance through the approval instance Code, including the name of the approval instance, the creation time, the user who initiated the approval, the status, and the task list.
Query the user's task list
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Query the user's task list. Query task list by user and task group.
Refuse approval task
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Refuse approval task. Reject an individual approval task. After rejection, the approval process ends. Execution applies the rejection immediately, may notify participants, and ends the current workflow; this action cannot undo that decision.
Return the approval task
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Return the approval task. From the current approval task, return to one or more approved task nodes. After returning, the approved nodes regenerate the approval task. Execution applies the return immediately, regenerates workflow tasks, and may notify participants; this action cannot undo the return.
Send a reminder message
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Send a reminder message. When it is necessary to urge the approver to approve the document, send a reminder message to the approver through this interface Execution sends the reminder immediately and may notify the approver; this action cannot undo the reminder.
sign approval task
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. sign approval task. Adds an approver to a single approval task. Execution adds the approver immediately and may notify or disclose the task to that user; this action cannot undo the addition.
Transfer approval tasks
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Transfer approval tasks. Transfer for a single approval task. After transfer, the approval process flows to the delegate. Execution transfers the task immediately and may notify the delegate; this action cannot undo the transfer.
Withdraw approval instance
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Withdraw approval instance. Under the condition of complying with the revocation rules, you can call this interface to withdraw the approval instance submitted by the current user identity. Execution withdraws the approval instance immediately and may notify workflow participants; this action cannot undo the withdrawal.
Get User Information
Required connected-account bundle: communication_scheduling (Communication & Scheduling), content_knowledge (Content & Knowledge), work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get User Information. Get related user info via user_access_token.
Bind Exchange account to Lark account
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Bind Exchange account to Lark account. Call this interface to bind the Exchange account to the Lark account, thereby supporting the import of the Exchange calendar. Provider constraints: Notice:Only a super administrator of the company can perform this action.
Create access control
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create access control. Call this interface to add access control to the specified calendar in your current identity (application or user), that is, calendar member permissions.
Create an event
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create an event. Call this interface to create a event on the specified calendar with the current identity (application or user).
Create a shared calendar
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create a shared calendar. Call this interface to create a shared calendar for the current identity (app or user).
Create event invitees
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create event invitees. Use this interface to add one or more invitees to a specified event with the current identity (app or user). Invitee types include users, groups, meeting rooms, and emails. Provider constraints: Notice:- The current identity is determined by the Token type of Header Authorization. tenant_access_token refers to the application identity, and user_access_token refers to the user identity. - If you use the application identity to call this interface, you need to ensure that the application turns on bot capability. - The current identity needs to have writer or owner permissions on the calendar, and the calendar type can only be primary or shared. You can call the Query Calendar Information interface to obtain the calendar type and the current identity's access rights to the calendar. - The current identity needs to be the organi...
Create meeting chat
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create meeting chat. Call this interface in the current identity (app or user) to create a meeting group for a specific event. Notice:- The current identity is determined by the Token type of Header Authorization. tenant_access_token refers to the application identity, and user_access_token refers to the user identity. - If you use the application identity to call this interface, you need to ensure that the application turns on bot capability. - The calendar where the event is located needs to be the primary calendar of the current identity and have the calendar's writer permissions. You can call the Query primary calendar information interface to obtain the primary calendar information of the current identity. - The event needs to have at least 2 participants added, and the participant list must not be hidden. You can call the Get event participa...
Create meeting minute
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create meeting minute. Call this interface to create meeting minutes for the specified schedule. The minutes are displayed in the form of documents, and the minutes document URL will be returned after successful creation.
Delete access control
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete access control. Call this interface to delete a certain access control in the specified calendar with the current identity (application or user), i.e., member permissions. This operation is destructive.
Delete an event
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete an event. Call this interface to delete an event on the specified calendar with the current identity (application or user). This operation is destructive.
Delete event invitees
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete event invitees. Call this interface to delete one or more invitees of the specified event with the current identity (app or user). This operation is destructive.
Delete shared calendar
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete shared calendar. Call this interface to delete a specified shared calendar under the current identity (application or user). This operation is destructive.
Query the binding status of the Exchange account
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Query the binding status of the Exchange account. Call this interface to obtain the binding status of the Exchange account, including the synchronization status of the Exchange calendar. Provider constraints: Notice:Only a super administrator of the company can perform this operation.
Get recurring schedule instances
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Get recurring schedule instances. Call this interface with the current identity (app or user) to obtain information about a specific recurring event in a specified calendar. Notice:The current identity is determined by the Token type of Header Authorization. tenant_access_token refers to the application identity, and user_access_token refers to the user identity.
Obtain the list of members of group invitees of an event
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain the list of members of group invitees of an event. Call this interface with the current identity (app or user) to get the group member list of the group type invitees in the event.
Obtain an event
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain an event. Call this interface with the current identity (app or user) to obtain the event information within a specified calendar, including the title of the event, time period, video conference information, public scope, and invitee rights, etc.
Obtain event invitee list
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain event invitee list. Call this interface to retrieve the list of invitees for a event with the current identity (app or user).
Obtain event list
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain event list. Call this interface with the current identity (app or user) to obtain the event list under a specified calendar. Provider constraints: Notice:- The current identity is determined by the Token type of Header Authorization. tenant_access_token refers to the application identity, and user_access_token refers to the user identity. - The current identity must have reader, writer or owner permissions on the calendar, and only supports obtaining the event list of primary, shared and resource type calendars. Google and Exchange type calendars are not supported yet. You can call the Query Calendar Information interface to obtain the current identity’s access rights to the calendar and calendar type information. - The page_token request parameter paging is used to pull existing data, and the sync_token request parameter is used to increme...
Obtain the ACL
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain the ACL. Call this interface to get the access control list of the specified calendar as the current identity (application or user).
Query availability of the primary calendar
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Query availability of the primary calendar. Call this interface to query the busy/free information of the specified user's primary calendar, or to query the busy/free information of the specified meeting room.
Query calendar information
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Query calendar information. Call this interface to query the information of a specified calendar with the current identity (application or user).
Query event view
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Query event view. Call this interface with user identity to query the event view under a specified calendar. Unlike Getting event list, the current interface will expand into multiple event instances according to the repetitiveness rules of the recurring event, and return the corresponding event instance information according to the queried time interval. Notice:- The current identity is determined by the Token type of Header Authorization. tenant_access_token refers to the application identity, and user_access_token refers to the user identity. - The current identity must have reader, writer or owner permissions on the calendar, and only supports obtaining the event list of primary and shared calendars. Google and exchange calendars are not supported yet. You can call the Query Calendar Information interface to obtain the current identity’s acces...
Query primary calendar information
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Query primary calendar information. Call this interface to get the main calendar information of the current identity (application or user).
Query the calendar list
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Query the calendar list. Call this interface to page through and query the calendar list of the current identity (application or user).
Search for calendars
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Search for calendars. Invoke this interface to search the calendar by keyword. The search results will be public calendars or the user's main calendar where the title or description contains the keyword.
Search for events
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Search for events. Call this interface to search for relevant events under the specified calendar, supporting keyword search and filter condition search.
Subscribe to changes in calendar access control
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Subscribe to changes in calendar access control. Call this interface in the identity of the user to subscribe to access control change events under the specified calendar.
Subscribe to a calendar
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Subscribe to a calendar. Call this interface to subscribe to the specified calendar with the current identity (application or user).
Subscribe to calendar change events
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Subscribe to calendar change events. Call this interface to subscribe the current user identity to the Calendar Change Event.
Subscribe to event changes
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Subscribe to event changes. Call this interface with user identity to subscribe to event change events under a specified calendar.
Unbind meeting chat
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Unbind meeting chat. Call this interface in the current identity (app or user) to unbind the created meeting group for the event. Notice:- The current identity is determined by the Token type of Header Authorization. tenant_access_token refers to the application identity, and user_access_token refers to the user identity. - If you use the application identity to call this interface, you need to ensure that the application turns on bot capability. - The calendar where the event is located needs to be the primary calendar of the current identity and have the calendar's writer permissions. You can call the Query primary calendar information interface to obtain the primary calendar information of the current identity. - The current operator needs to be the group owner of the conference group. This operation is destructive.
Unbind the Exchange account
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Unbind the Exchange account. Call this interface to unbind the relationship between the Exchange account and the Lark account. After the Exchange account is unbound, it can continue to bind with other Lark accounts. Provider constraints: Notice:Only a super administrator of the company can perform this operation. This operation is destructive.
Unsubscribe to changes in calendar access control
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Unsubscribe to changes in calendar access control. Invoke this interface in the user's identity to unsubscribe from access control change events under the specified calendar.
Unsubscribe from a calendar
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Unsubscribe from a calendar. Call this interface with the current identity (application or user) to unsubscribe from the specified calendar. Provider constraints: Notice:- The current identity is determined by the Token type of Header Authorization. The tenant_access_token refers to the application identity, and the user_access_token refers to the user identity. - If this interface is called with the application identity, make sure that the application has enabled the Bot ability. - Only calendars that have been subscribed to by the current identity can be operated.
Unsubscribe to calendar change events
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Unsubscribe to calendar change events. Call this interface to unsubscribe the current user identity from the Calendar Change Event.
Unsubscribe to event changes
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Unsubscribe to event changes. Call this interface to unsubscribe from event change events in the specified calendar as a user.
Update an event
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Update an event. Call this interface with the current identity (app or user) to update a event on a specific calendar, including information such as the event title, description, start and end time, video conference, and event location.
Update calendar information
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Update calendar information. Call this interface with the current identity (application or user) to modify the title, description, public range, and other information of the specified calendar.
Create Department
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Create Department. This interface is used to create a new department in the enterprise address book, supporting the setting of information such as department name, parent department, and department head. Notice:Attention: - Departments can only be created under departments within the scope of the address book authorization of the current application. If you want to create a sub-department under the root department, you must have full permissions. You can view the address book authorization scope in the developer background - application details - permission management. - The user_access_token supported in this interface defaults to the administrator user, and the administrator management scope will be verified. When the user has multiple administrator identities to create departments, the administrator management scope takes the maximum set.For information on administrator permi...
Create Employee
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Create Employee. This API is used to create an employee under the enterprise. It supports passing in information such as name and mobile phone number to generate an employee object in the active state. Employees refer to members with the identity of "Employee" in the Lark enterprise, which is equivalent to the "User" in the address book OpenAPI. Notice:Attention: - Employees can only be created under the departments within the address book authorization scope of the current application. To create employees under the root department, you must have full permissions. You can view the address book authorization scope in the developer background - application details - permission management. - The user_access_token supported in this interface is the administrator user by default, and the administrator management scope will be verified. When a user has multiple administrator identitie...
Delete department
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Delete department. This interface is used to delete departments. Notice:Note: - Deleting a department requires application data permissions for the department to be deleted and its parent department Configure application data permissions This operation is destructive.
Get departmental information in bulk
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Get departmental information in bulk. This interface supports passing in multiple department IDs and returns detailed information for each department (such as name, person in charge, sub-departments, etc.). Notice:Attention: - This interface supports tenant_access_token and user_access_token. - When using tenant_access_token, data permissions follow the application's contacts permissions, and the returned field data is limited to fields for which the application has permissions. You can determine the application's contacts permissions by referring to Get Application Contacts Permissions Configuration. - When using user_access_token, it defaults to an administrator user, and the administrator's management scope will be verified. When a user has multiple administrator identities that can all view department information, the administrator's management scope will be the maximum set....
Get department list
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Get department list. This interface is used to obtain the list of eligible department details in batches according to the specified conditions. Notice:Attention: - This API supports tenant_access_token and user_access_token. - When using tenant_access_token, data permissions follow the contacts permissions of the application, and the returned field data consists of fields for which the application has permissions. You can view the contacts authorization scope in the Developer Console - Application Details - Permissions Management. - When using user_access_token, it defaults to an administrator user, and the administrator's management scope will be verified. When a user has multiple administrator identities and can view department information with all of them, the administrator's management scope will be the maximum set. Administrators can view the Help Center document: Administr...
Get employee information in bulk
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Get employee information in bulk. This interface is used to query the details of employees according to their IDs in batches.Such as employee name, mobile phone number, email, department and other information. Employee refers to a member of Lark's enterprise who is identified as "Employee", which is equivalent to "User" in the contact OpenAPI. Notice:Attention: - This interface supports tenant_access_token and user_access_token - When using tenant_access_token, the data permissions follow the contacts permissions of the application, and the returned field data is the field for which the application has permissions. You can determine the contacts permissions of the application by Getting the Contacts Permissions Configuration of the Application. - When using user_access_token, the user is considered an administrator by default, and the administrator's management scope will be ver...
Get the employee list in bulk
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Get the employee list in bulk. This interface is used to obtain a batch list of eligible employee details according to the specified conditions. Employee refers to a member of Lark's enterprise who is identified as "Employee", which is equivalent to "User" in the contact OpenAPI. Notice:Attention: - This API supports tenant_access_token and user_access_token. - When using tenant_access_token, the data permissions follow the contacts permissions of the application, and the returned field data is the field for which the application has permissions. You can determine the contacts permissions of the application by Getting the contacts permissions configuration. - When using the user_access_token, the user is considered an administrator by default, and the administrator's management scope will be verified. When a user has multiple administrator identities and can view employee inform...
Obtain the list of users directly under a department
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain the list of users directly under a department. This API is used to obtain the list of users directly under a department based on the department ID. Provider constraints: Notice:- Department ID is required. The root department ID is 0. - When user_access_token is used, the filtering is based on the users' visible scope of organization, and the user data within the users' visible scope of organization ([Log in to the company's Admin to manage scopes]) will be returned. - When tenant_access_token is used, the filtering is based on the app's contact scope. If the requested department ID is 0, the system verifies whether the app has the all-staff contact scope. If the department ID is not 0, the system verifies whether the app has the contact scope of the department. If no, an error code indicating no scope will be returned. If yes, the list of use...
Modify user information in part
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Modify user information in part. This API is used to update a user's fields in Contacts. Parameters that are not specified will not be updated.
Obtain bulk department information
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain bulk department information. This API is to obtain the information of bulk departments in Contacts. Provider constraints: Notice:- When using tenant_access_token, the application must obtain the access permission of the contacts of the requested department. To access root department information, the application must have an all-staff contact scope. - When using user_access_token, users must obtain the visibility scope of the requested department. To access root department information, the visibility scope must include all employees. Notice:- When using tenant_access_token, the application must obtain the access permission of the contacts of the requested department. To access root department information, the application must have an all-staff contact scope.
Obtain multiple users' information
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain multiple users' information. This API is used to obtain the information of bulk users in Contacts.
Obtain parent department information
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain parent department information. This API is used to recursively obtain the information of parent departments, and return the list of the information of parent departments within the permission scope from child departments to parent departments. Provider constraints: Notice:When tenant_access_token is used, this API only returns the information of parent departments within the visible scope. For example, for Departments A>>B>>C>>D (A has the highest level), if the contact scope is Department B, querying parent departments of department D will return Department B and Department C. When user_access_token is used, this API only returns the information of parent departments visible to the user. For example, for Departments A>>B>>C>>D (A has the highest level), if the contact scope is Department B, querying parent departments of department D will ret...
Obtain single department information
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain single department information. This API is used to obtain the information of a single department in contacts. Provider constraints: Notice:- When using tenant_access_token, the app must have the contacts scope of the department to be queried. To obtain root department information, the app must have the all-staff contact scope. - When using user_access_token, you must have the visibility of the department to be queried. To obtain root department information, you must have the visibility of all employees. Notice:- When using tenant_access_token, the app must have the contacts scope of the department to be queried. To obtain root department information, the app must have the all-staff contact scope.
Obtain single user's information
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain single user's information. This API is used to obtain the information of a single user in Contacts.
Obtain the list of sub-departments
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain the list of sub-departments. This API is used to obtain the list of sub-departments by using the department ID. Provider constraints: Notice:- Department ID is required. The root department ID is 0. - When user_access_token is used, all departments within the user's visible scope of organization (Log in to the company's Admin to manage scopes) will be returned. If a recursive query is executed, only 1,000 departments at most will be filtered for visibility. - When tenant_access_token is used, the departments will be filtered by verification against the range of contacts data that the app can access. If the department ID is 0, the system checks whether the app has the all-staff contact scope. If the department ID is not 0, the system checks whether the app has the contact scope of the department. If no, an error code indicating no scope to acce...
Reinstatement of resigned employees
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Reinstatement of resigned employees. This interface is used to restore the members who have left the company and restore them to the working state. Notice:Attention: - To restore the resigned employee as in-service, the enterprise version needs to be in the commercial professional version and above,You can view the current version of the enterprise through the management background> settings> version information , and the employee needs to leave within 30 days. After recovery, some user data is still unrecoverable, please call with caution. - The user ID of the member to be restored cannot be used by other members in the enterprise.You can query whether the User Identification exists through the Batch Get Employee List interface . If there is any duplication, please leave the corresponding member first, otherwise the interface will report an error. - The mobile phone number and...
Resign employee
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Resign employee. This interface is for resign employees. Notice:Attention: - This interface supports tenant_access_token and user_access_token. - When using tenant_access_token, employees can only leave within the scope of the address book authorization currently applied. - If an employee belongs to multiple departments, the app needs to have the authority of all departments to which the employee belongs in order to leave successfully. - When using user_access_token, the default is the administrator user, and the administrator management scope will be verified. When the user has multiple administrator identities and can leave employees, the administrator management scope takes the maximum set. This operation is destructive.
SearchDepartment
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. SearchDepartment. This interface is used to search for department information, search for department information through keywords such as department names, and return a list of departments that meet the criteria. Notice:Attention: - This interface supports tenant_access_token and user_access_token. - When using tenant_access_token, the data permissions follow the contacts permissions of the app, and the field data returned is the field that the app has permissions for. - When using user_access_token, the default is the administrator user, and the administrator management scope will be verified. When the user has multiple administrator identities to view employee information, the administrator management scope takes the maximum set.
Search Employee Information
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Search Employee Information. This interface is used to search for employee information, such as searching for employee names, mobile phone numbers, email addresses and other information through keywords. An employee is a member of Lark who is an "Employee", which is equivalent to a "User" in the Contacts OpenAPI Notice:Attention: - This API supports tenant_access_token and user_access_token. - When using tenant_access_token, the data permissions follow the contacts permissions of the application, and the returned field data is the field for which the application has permissions. You can determine the contacts permissions of the application by Getting the Contacts Permissions Configuration of the Application. - When using the user_access_token, the user is considered an administrator by default, and the administrator's management scope will be verified. When a user has multiple a...
Search for departments
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Search for departments. This API is used to search for department data with keywords. Department visibility is set by administrators in Admin. Provider constraints: This API is used to search for department data with keywords. Department visibility is set by administrators in Admin. Notice:If a department exists but the user cannot find it, this may also be because the administrator has set the department visibility.
Update department
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Update department. This interface is used to update department information. Only the parts param that are explicitly passed are updated. Notice:- Department information can only be updated within the scope of the address book authorization of the current application (which can be viewed via the management backend > application permissions > address book authorization page). - To change the parent department of a department, you need to have the department permissions both before and after the change to succeed. - To change the head of a department, you need to have the personnel permissions before and after the change to ensure a successful change. - The user_access_token supported in this interface defaults to an administrator user, and the administrator's management scope will be verified. When a user has multiple administrator identities that can all update departments, the a...
Update employee information
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Update employee information. This interface is used to update the information of current/former employees, freeze/restore employees. Unpassed parameters will not be updated. Employee refers to a member of Lark's enterprise who is identified as "Employee", which is equivalent to "User" in the address book OpenAPI. Notice:- The modification of employee status follows the rules of life cycle flow. For details, please refer to Directory-Employee Management-Resource Introduction. - This interface supports tenant_access_token and user_access_token.Refer to Get Access Credentials for the interface acquisition method. - When using tenant_access_token, employee information can only be updated within the scope of the current app's address book authorization.can be viewed in Developer Backend > Permission Management > Address Book Permission. - When changing an employee's department inform...
Update pre-resigned employee to unresigned
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Update pre-resigned employee to unresigned. This interface is used to cancel the departure of the pending employee and update it to the "on-the-job" status. When canceling the departure, the departure information will be cleared. When using user_access_token, it defaults to an administrator user, and only administrators who can has "CoreHR Management" role can operate it.
Update unresigned employees to pre-resigned
Required connected-account bundle: directory (Directory). Select a connection authorized for this bundle. Update unresigned employees to pre-resigned. This interface is used to handle the departure of current employees and update them to the status of "pending departure". "pending departure" employees will not automatically leave, and need to use the "delete employee" API to terminate and transfer resources. When using user_access_token, it defaults to an administrator user, and only administrators who have the "CoreHR Management" role can operate it.
Access to Wiki space information
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Access to Wiki space information. This interface is used to query the information of the Wiki space according to the Wiki space ID. Provider constraints: Space type: - Person Space: Managed by individuals. One person can only have one personal space, and no other administrators can be added. - Team Space: Managed by a team (multiple people), multiple administrators can be added. Space visibility: - Public Space: Visible to all users within the tenant and defaults to member permissions. Additional members cannot be added, but administrators can be added. - Private Space: Only visible to knowledge space administrators and members, administrators and members need to be added manually.
Add a Global Comment
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Add a Global Comment. Adds a global comment to Docs.
Sheet operations
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Sheet operations. Use this API to add, copy, or delete sheets based on a spreadsheetToken. This API uses the same request URL as Update sheet properties, but has different parameters. Read this document carefully before calling. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot. This operation is destructive.
Add permissions
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Add permissions. This API is used to add permissions on a document for a user based on a filetoken.
Add protected range
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Add protected range. Use this API to add multiple protected ranges based on spreadsheetToken and dimension information. You can operate on up to 5000 rows or columns. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Add rows and columns
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Add rows and columns. This API is used to add blank rows and columns at the end of a spreadsheet based on spreadsheetToken and length. You can add up to 5,000 rows or columns at once. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Add Wiki space members
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Add Wiki space members. Operates the documented `/wiki/v2/spaces/{space_id}/members` resource. Provider constraints: - Public Wiki space (visibility is public) is visible to all users of the tenant, so adding members is not supported, but admins can be added. Related error: 131101 public wiki space can't create members. - Personal Wiki space (type is person) is a personally managed Wiki space, adding other admins (including applications/bots) is not supported. But members can be added. Related error: 131101 person wiki space can't create admin.
Append data
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Append data. This API is used to append data by overwriting blank rows or adding new rows based on spreadsheetToken and range. Blank row: By default, when the first cell of the row is empty, the row will be considered blank. You can write up to 5,000 rows and 100 columns of data at once. A single cell can't exceed 50,000 characters. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Batch create members
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Batch create members. Add role members with custom permissions in bulk
Batch create table
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Batch create table. Operates the documented `/bitable/v1/apps/{app_token}/tables/batch_create` resource.
Batch delete members
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Batch delete members. Batch delete role members This operation is destructive.
Batch delete nodes
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Batch delete nodes. Delete nodes in board, and all descendant nodes are recursively removed. This operation is destructive.
Batch delete table
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Batch delete table. Operates the documented `/bitable/v1/apps/{app_token}/tables/batch_delete` resource. This operation is destructive.
Batch get records
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Batch get records. Batch get records by record ids
Batch Query Comments
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Batch Query Comments. This API is used to obtain cloud document comment information in batches according to comment ID list, including comment and reply ID, reply content, user ID of reviewer and reply person, etc. Supports returning global comments as well as local comments (which can be distinguished by the "is_whole" field).
Batch Update Blocks
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Batch Update Blocks. Batch update the specified block and return its updated rich text content.
Cancel User Subscription to Cloud Document Events
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Cancel User Subscription to Cloud Document Events. This interface is used to unsubscribe users from notification events of cloud documents.After canceling the subscription, the user will no longer receive events related to comments and reply additions on cloud documents. This operation is destructive.
Complete uploading a file in blocks
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Complete uploading a file in blocks. Completes an upload task.
Convert Markdown/HTML to document blocks
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Convert Markdown/HTML to document blocks. Convert Markdown/HTML formatted content into document blocks to facilitate the insertion of Markdown/HTML formatted content into a document. Currently, the supported block types for conversion include text, heading(1 - 9), bullet, ordered, code, quote, todo, image, table and table_cell.
Copy App
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Copy App. Copy a base app, you can specify to copy to a folder with permissions Provider constraints: 403 | 1254304 | PermNotAllow | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Copy Dashboard
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Copy Dashboard. This interface is used to duplicate a new dashboard from an existing dashboard.
Copy File
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Copy File. Copy a file to a different folder in the user's Space. Folders cannot be copied.
Create a filter
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create an automatic filter over a cell range in the specified sheet.
Create a filter condition
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Add a condition to the specified spreadsheet filter view.
Create a floating image
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create a floating image anchored in the specified spreadsheet sheet.
Create an export task
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create an export task. Create an export task and export the Docs to a local file in the specified format. Currently, the Upgraded Docs, Sheets, Bitable and Docs are supported. This API is asynchronous. The task is created and returned immediately. It will not block and wait until the task is executed successfully. Therefore, it is necessary to combine the Query Export Task Results to obtain the export results.
Create an import task
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create an import task. Create import tasks. Supports importing Upgraded Docs, Sheets, Bitable and Docs. This API is asynchronous, you need to get the import result by Query the import task result . Detailed operation steps can be found in the Import Usage Guide.
Create a node copy
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create a node copy. This interface is used for creating a copy of a node to a specified location.
Create App
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create App. Create a base app in user-defined folder Provider constraints: 200 | 1254304 | PermNotAllow | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Create a record
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create a record. Operates the documented `/bitable/v1/apps/{app_token}/tables/{table_id}/records` resource. Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Create a table
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create a table. Add a new table in Base, supporting the input of table name, view name, and fields.
Create Block
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create Block. Creates a batch of children blocks for a given block and inserts them at a specific location. The return value of this API is the rich text content of the newly created children blocks.
Create conditional formatting
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create conditional formatting. Use this API to create new conditional formatting. You can add up to 10 conditional formats at once. Each conditional formatting setting operation returns success or failed. Parameter verification information is returned for failed operations. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Create Document
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create Document. Supports specifying the space directory through the folder_token parameter.
Create document version
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create document version. Operates the documented `/drive/v1/files/{file_token}/versions` resource.
Create field
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create field. Create a field Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Create field group
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Create field group. Create group for fields of the Bitable data table
Create filter view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create a named filter view in the specified spreadsheet sheet.
Create Folder
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create Folder. Creates a new empty folder within the specified parent folder in the user's Space.
Create member
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create member. Create a member
Create nested blocks
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create nested blocks. Creates a batch of nested blocks (blocks with parent-child relationship) for a given block and inserts them at a specific location. The return value of this API is the rich text content of the newly created blocks. To learn about the parent-child relationship between blocks, see Document overview-Basic concept. When the created child block contains GridColumn, TableCell, and Callout, it must contain at least one child block. That is, if the content is empty, an empty Text Block must be filled in as a child block.
Create node
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create node. This interface is used to create nodes in the wiki base
Create online document
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create online document. Create a document, sheet, or bitable in user-defined folders in the user's Space. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Create records
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create records. Create records,up to 500 lines at a time. Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Create role
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create role. Create a role Provider constraints: 403 | 1254304 | Only Available For Business and Enterprise Editions | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Create spreadsheet
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create spreadsheet. Use this API to create an online spreadsheet under the specified directory.
Create Subscription
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create Subscription. Subscribe to change events in the document, currently supporting document comment subscriptions
New view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. New view. Add a view to the data table
Create Node
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Create Node. Create nodes, supporting batch creation and creating nodes with parent-child relationships.
Create Wiki space
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Create Wiki space. This interface is used to create a Wiki space
Delete a filter
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete a filter. This API is used to delete the filter of a sheet. This operation is destructive.
Delete a floating image
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete a floating image. This API is used to delete the floating image with the specified float_image_id. This operation is destructive.
Delete a record
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete a record. Operates the documented `/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}` resource. Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions This operation is destructive.
Delete Blocks
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete Blocks. Specifies the block that needs to be manipulated, deletes its specified range of children blocks, and returns the version of the document with the action applied. We can regard the Upgraded Docs as a block tree, and the deleted block can be regarded as the child of its parent block, that is, it is clear that the block to be deleted is the first child of its parent block, and then this API is called to delete it. This operation is destructive.
Delete conditional formatting
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete conditional formatting. Use this API to delete an existing conditional formatting. You can delete up to 10 conditional formats at once. Each conditional formatting deletion operation returns success or failed. Parameter verification information is returned for failed operations. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot. This operation is destructive.
Delete document version
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete document version. Operates the documented `/drive/v1/files/{file_token}/versions/{version_id}` resource. This operation is destructive.
Delete drop-down settings
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete drop-down settings. Use this API to remove drop-down settings but retain option text for cells in the selected data range based on spreadsheetToken and range. A single delete range cannot include more than 5,000 cells, and each request cannot specify more than 100 ranges. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot. This operation is destructive.
Delete field
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete field. Delete a field Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions This operation is destructive.
Delete file
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete file. Delete a file or folder from user's Space. After the file or folder is deleted, it will go to the user's recycle bin. Provider constraints: Notice:Deleting file requires ensuring that the app has one of the following two permissions: 1. The app is the owner of the file and has edit rights to the parent folder where the file is located. 2. The app is not the owner of the file, but is the owner of the parent folder where the file is located or has full access to the parent folder. Notice:This API doesn't support concurrent calls, and supports up to 5 queries per second (QPS). Deleting a folder will be executed asynchronously and a task_id will be returned. You can use the task_check interface to query the task execution status. This operation is destructive.
Delete filter conditions
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete filter conditions. This API is used to delete filter conditions for a specified column in the range of a filter view. This operation is destructive.
Delete filter view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete filter view. This API is used to delete the filter view corresponding to the specified ID. This operation is destructive.
Delete member
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete member. Delete a member This operation is destructive.
Delete permissions of a collaborator
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete permissions of a collaborator. This API is used to delete permissions of a document collaborator based on a filetoken. This operation is destructive.
Delete protected range
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete protected range. Use this API to delete a protected range based on the protected range ID. Each operation can delete up to 10 IDs. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot. This operation is destructive.
Delete records
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete records. Delete records,up to 500 lines at a time. Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions This operation is destructive.
Delete Reply
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete Reply. Deletes a reply to a document in Docs. This operation is destructive.
Delete role
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete role. Delete a role This operation is destructive.
Delete rows or columns
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete rows or columns. This API is used to delete rows and columns based on spreadsheetToken and dimension information. You can delete up to 5,000 rows and columns at once. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot. This operation is destructive.
Delete Table
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete Table. Delete a table This operation is destructive.
Delete view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete view. Delete views from data tables This operation is destructive.
Delete Wiki space members
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Delete Wiki space members. This method is used to delete Wiki space members. Provider constraints: - Public Wiki space (visibility is public) is visible to all users of the tenant, so removing members is not supported, but admins can be removed. This operation is destructive.
Download a file
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Download a file. This API is used to download files from a directory in My Space, excluding online documents in Lark Docs, Sheets, and MindNotes. You can download a file based on a specified range.
Download a material
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Download a material. This API is used to download materials. Materials refer to files in various production containers, for example, images in a document and files. You can download a material based on a specified range.
Download export file
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Download export file. According to the export product token returned by the Query export task results, download the export product file to the local.
Download Whiteboard As Image
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Download Whiteboard As Image. Download whiteboard as an image, the response data is returned as a binary image stream. The image format is determined by the Content-Type header value: image/png, image/jpeg, image/gif, image/svg+xml.
Search
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Search. Search cell locations that match specified conditions in a certain range of the sheet. The range and find fields are required in the request body.
## Request
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Complete a multipart media upload after all blocks have been uploaded.
Get a Global Comment
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get a Global Comment. Obtains a specified global comment in Docs. Local comments are not supported yet. Provider constraints: Obtains a specified global comment in Docs. Local comments are not supported yet.
Get a list of Wiki spaces
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get a list of Wiki spaces. This interface is used to get a list of Wiki spaces that have permission to access.
Get App Information
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get App Information. Get App information through app_token
Get conditional formatting
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get conditional formatting. Use this API to get detailed conditional formatting based on a sheetId. Each operation can query up to 10 sheetIds. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Get docs content
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get docs content. You can obtain the docs content. Currently, only upgraded document content in markdown format is supported.
Get Document Comments in Pages
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get Document Comments in Pages. The API is used to obtain all the comment information of the document according to the cloud document Token, including comment and reply ID, reply content, user ID of the reviewer and reply person, etc. The API supports returning global comments as well as local comments (which can be distinguished by the "is_whole" field). The default is 50 comments per page.
Obtain the common settings of a document V2
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain the common settings of a document V2. This API is used to obtain the common settings of a document based on a filetoken. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Get document version
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get document version. Operates the documented `/drive/v1/files/{file_token}/versions/{version_id}` resource.
Obtain the meta information of a root folder in My Space
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain the meta information of a root folder in My Space. This API is used to obtain the meta information of "My Space." Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Get protected range
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get protected range. Use this API to get detailed row and column information for a protected range based on the protected range ID. Each operation can query up to 5 IDs. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Get Replies List
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get Replies List. This interface is used to obtain replies according to the comment ID and pagination parameters.
Get sheet
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get sheet. This interface is used to get all sheets and their properties under the spreadsheet.
Get spreadsheet metadata
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get spreadsheet metadata. Use this API to get spreadsheet metadata based on a spreadsheetToken. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Get subscription status
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get subscription status. Get the status of the subscription based on the subscription ID
Get the list of child nodes
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get the list of child nodes. This interface is used for pagination to get the list of child nodes of Wiki nodes.
Get theme
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Get theme. Get board theme. Different themes have different default color schemes. For detailed theme descriptions, refer to the theme introduction .
Get view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get view. This interface gets existing views based on view_id.
Get Wiki node information
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get Wiki node information. Get wiki node inforamtion
Insert data
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Insert data. This API is used to write data to add rows and corresponding data before a specified range based on spreadsheetToken and range. This is equivalent to an array insert action. You can write up to 5,000 rows and 100 columns of data. A single cell can't exceed 50,000 characters. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Insert rows and columns
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Insert rows and columns. This API is used to insert rows and columns based on spreadsheetToken and dimension information. If startIndex=3 and endIndex=7, rows and columns are inserted from the 4th row until the 7th row, for a total of 4 rows. You can insert up to 5,000 rows or columns at once. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
List a form
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List a form. Give form according to app_token, table_id and form_id Provider constraints: 403 | 1254304 | You are not authorized to perform this operation. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
List all tables
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List all tables. According to app_token, get all tables under app.
List automations
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List automations. This interface is used to list the automations of base
List dashboards
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List dashboards. According to app_token, get all dashboards under app
List document version
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List document version. Get all versions of the document.
List fields
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List fields. Get all fields according to app_token and table_id
List form fields
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List form fields. Give all form fields according to app_token, table_id and form_id
List items in folder
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List items in folder. Get the list of files under the specified folder in the user's cloud space. List item types include files, various online documents (doc, sheet, bitable, mindnote), folders, and shortcuts. This interface does support paging, but does not recursively get the list of subfolders.
List members
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List members. Get all members according to app_token and role_id
List roles
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List roles. Get all roles according to app_token
List view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List view. Get all views of the data table based on app_token and table_id
List workflow
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. List block workflows configured for this Base, returning each block workflow's ID, title, and enabled status. Use List automations to list app-level Base automations instead.
Merge cells
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Merge cells. This API is used to merge cells based on spreadsheetToken and dimension information. You can act on up to 5,000 rows and 100 columns at once. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Modify protected range
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Modify protected range. Use this API to modify a protected range based on the protected range ID. Each operation can modify up to 10 IDs. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Add an existing document to Wiki space
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Add an existing document to Wiki space. This interface allows to add existing cloud documents to the knowledge base and mount them under the specified parent page
Move File
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Move File. Move a file or folder to a different location in the user's Space.
Move node
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Move node. This method is used to move nodes within the Wiki and supports movement across the Wiki space
Obtain a collaborator list
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain a collaborator list. This API is used to query collaborators based on a filetoken. The collaborator type can be "user" or "chat." Notice:To obtain a collaborator list, you must have the permission to share the document. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Obtain a floating image
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get one floating image and its placement from the specified spreadsheet sheet.
Obtain all nodes of a board
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Obtain all nodes of a board. Obtain all nodes of a board. Nodes are returned as an array and can be assembled into the canvas structure via parent_id (parent node) and children (child nodes) relationships.
Obtain a temporary material download URL
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain a temporary material download URL. Obtain the temporary download URL of a material based on a file_token. The URL is valid for 24 hours.
Obtain filter
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain filter. This API is used to obtain the filter details for a sheet.
Obtain filter conditions
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get one condition from the specified spreadsheet filter view.
Obtain filter view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain filter view. This API is used to obtain the name and range of a specified filter view ID.
Obtain metadata
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain metadata. This API is used to obtain the metadata of various files based on a token.
Obtain meta information of a folder
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain meta information of a folder. This API is used to obtain the meta information of the current folder based on a folderToken. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Obtain statistics of a file
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Obtain statistics of a file. This API is used to obtain statistics of a file, including the number of unique visitors (UVs), the number of page views (PVs), and the number of likes.
Patch form
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Patch form. Update a form Provider constraints: 403 | 1254304 | You are not authorized to perform this operation. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Patch form field
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Patch form field. Update a form field
Upload a file in blocks (Preuploading)
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Upload a file in blocks (Preuploading). Sends an initialization request to obtain an upload transaction ID and a split policy. The current policy is to split a file into 4 MB fixed-length blocks.
## Request
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Start a multipart media upload and obtain its upload identifier.
Query All Blocks
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query All Blocks. Perform a deep traversal of all blocks in the specified document and return them in pagination.
Query asynchronous task status
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query asynchronous task status. Query the status information of asynchronous tasks such as delete folder.
Query Block
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query Block. Query the rich text content of the specified block.
Query Block Children
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query Block Children. Query the Children Block of the specified Block
Query cloud document event subscription status
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Query cloud document event subscription status. This interface is used to query the subscription status of cloud documents. To understand the configuration process and usage scenarios for event subscriptions, refer to Event Overview. To learn about the types of events supported by cloud documents, refer to Event List.
Query Document
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query Document. Query the latest version number, title, etc. of the document
Query Document Raw Content
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query Document Raw Content. Gets the plain text content of the document without rich text formatting information.
Query drop-down settings
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query drop-down settings. Use this API to query drop-down settings information in a specified range based on spreadsheetToken and range. The range of a single query cannot exceed 5,000 rows and 100 columns. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Query export task results
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query export task results. According to the result of the ticket polling export task returned by the Create an export task, after obtaining the file token of the export product through this API, the Download export file API can be invoked to download the export product to the local.
Query filter conditions
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List conditions configured on the specified spreadsheet filter view.
Query filter view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query filter view. This API is used to query the basic information of all filter views in a sheet, including their IDs, names, and ranges.
Query floating images
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. List floating images in the specified spreadsheet sheet.
Query sheet
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query sheet. This interface is used to query worksheet attribute information by worksheet ID.
Query the import task result
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Query the import task result. Polling the import results based on the ticket returned from the creation of the import task. Detailed operation steps can be found in the Import Usage Guide.
Query the Subscription Status of User Cloud Document Events
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Query the Subscription Status of User Cloud Document Events. This interface is used to query the subscription status of user cloud document events.Only when is_subscribe(subscription status) is true, can the application receive various notification events under "User Cloud Document Events".
Read a single range
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Read a single range. This API is used to read the values in a single range based on spreadsheetToken and range. No more than 10 MB of data can be returned. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Read multiple ranges
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Read multiple ranges. This API is used to read the values in multiple ranges based on spreadsheetToken and range. No more than 10 MB of data can be returned. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Replace
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Replace. Find data that matches specified conditions in a certain range of the sheet, replace the values, and return the location of the successfully replaced cell. You can replace up to 5,000 cells at a time. If the number of matching cells exceeds the limit, narrow the range before the action. The range, find, and replacement fields are required in the request body.
Retrieve the result of Wiki task
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Retrieve the result of Wiki task. This method is used to retrieve the result of a wiki task.
Rows or columns to move
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Rows or columns to move. This API is used to move rows and columns. After rows and columns are moved to a target location, the rows and columns already at the target location are shifted right or down.
Search for a document
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Search for a document. This API is used to search for a document based on search criteria. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Search records
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Search records. This api is used to query existing records in the table. A maximum of 500 rows of records can be queried at a time, and paging is supported.
Set cell style
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Set cell style. This API is used to set the cell style based on spreadsheetToken, range, and style information. You can act on up to 5,000 rows and 100 columns. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Set cell styles in batches
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Set cell styles in batches. This API is used to set the style of multiple cells based on spreadsheetToken, range, and style information. You can act on up to 5,000 rows and 100 columns. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Set drop-down
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Set drop-down. Use this API to set drop-down rules for cells based on spreadsheetToken, range, and drop-down properties. The range of a single operation cannot exceed 5,000 rows and 100 columns. When data already exists in the selected range, valid values are converted to options. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Solve or Restore a Comment
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Solve or Restore a Comment. Solves or restores a comment on a document in Docs.
Split cells
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Split cells. This API is used to split cells based on spreadsheetToken and dimension information. You can act on up to 5,000 rows and 100 columns at once. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Subscribe Docs events
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Subscribe Docs events. This interface is used to subscribe to various notification events of cloud documents. To understand the configuration process and usage scenarios for event subscriptions, refer to Event Overview. To learn about the types of events supported by cloud documents, refer to Event List.
Subscribe to User Cloud Document Events
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Subscribe to User Cloud Document Events. Subscribe to various notification events of user cloud documents. After invoking, you can currently obtain cloud document comment and reply addition events from the recipient's perspective.
Transfer owner
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Transfer owner. This API is used to transfer a document owner based on document information and user information. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot. This operation is destructive.
Unsubscribe Document events
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Unsubscribe Document events. This interface is used to unsubscribe from notification events of cloud documents. To understand the configuration process and usage scenarios for event subscriptions, refer to Event Overview. To learn about the types of events supported by cloud documents, refer to Event List. This operation is destructive.
Update a filter
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Replace the automatic filter range or criteria in the specified sheet.
Update a floating image
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update a floating image. Operates the documented `/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/float_images/{float_image_id}` resource.
Update App Information
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update App Information. Update app information according to app_token Provider constraints: Notice:- Advanced permissions are not supported for Base in doc, sheet and wiki - This API is not an atomic operation. It firstly modifies name, and then switches advanced permissions. It may be partial success 403 | 1254304 | The role has no permissions. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Update a record
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update a record. Operates the documented `/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}` resource. Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Update Block
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update Block. Updates the specified block and returns its updated rich text content.
Update common settings of a document
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update common settings of a document. This API is used to update the common settings of a document based on a filetoken.
Update conditional formatting
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update conditional formatting. Use this API to update an existing conditional formatting. You can update up to 10 conditional formats at once. Each conditional formatting update operation returns success or failed. Parameter verification information is returned for failed operations. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Update data table
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update data table. This interface is used to update the basic information of the data table, including the name of the data table, etc.
Update drop-down settings
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update drop-down settings. Use this API to update drop-down properties based on spreadsheetToken, sheetId and range. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Update field
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update field. Update a field Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Update filter conditions
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update filter conditions. Lark seamlessly integrates messaging, calendars, docs, and video for enhanced team collaboration.
Update filter view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update the name or range of the specified spreadsheet filter view.
Update records
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update records. Update records,up to 500 lines at a time. Provider constraints: 403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Update Reply
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update Reply. Updates a reply to a document in Docs.
Update role
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update role. Update a role Provider constraints: 403 | 1254304 | Only Available For Business and Enterprise Editions | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
Update rows and columns
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update rows and columns. This API is used to update hidden rows and columns and cell sizes based on spreadsheetToken and dimension information. You can act on up to 5,000 rows and columns at once. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Updates permissions of a collaborator
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Updates permissions of a collaborator. This API is used to update permissions of a document collaborator based on a filetoken.
Update spreadsheet properties
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update spreadsheet properties. Use this API to update spreadsheet properties, including spreadsheet titles, based on a spreadsheetToken. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Update subscription status
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update subscription status. Update subscription status based on subscription ID
Update Theme
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Update Theme. Update board theme. For detailed theme descriptions, refer to the theme introduction .
Update title
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update title. This interface is used for updating node title. Provider constraints: Notice:This interface currently only supports doc, docx and shortcuts.
Update view
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update view. This interface is used to incrementally modify view information.
Update Wiki space settings
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update Wiki space settings. Update the public settings of the Wiki space according to space_id
Update Workflow status
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Update Workflow status. This interface can be used to update Workflow status
Upgrade form
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Upgrade form. Upgrade legacy forms to collection forms
Upload file
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Upload file. Uploads a small file to user's Space.
Upload a file in blocks (Upload blocks)
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Upload a file in blocks (Upload blocks). Uploads blocks of a specified file.
Uploads a material (images or files) required by Docs or other Lark suite to My Space.
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Uploads a material (images or files) required by Docs or other Lark suite to My Space.. Operates the documented `/drive/v1/medias/upload_all` resource.
## Request
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Upload one numbered block for an active multipart media upload.
whiteboard syntax parse
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. whiteboard syntax parse. Currently artboard supports converting PlantUml and Mermaid to artboard data
Write a image
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Write a image. This API is used to write an image to the specified cell based on the spreadsheetToken and range. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Write data to a single range
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Write data to a single range. This API is used to write data to a single range based on spreadsheetToken and range. Any data in the range will be overwritten. You can write up to 5,000 rows and 100 columns of data. A single cell can't exceed 50,000 characters. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Write data to multiple ranges
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Write data to multiple ranges. This API is used to write data to multiple ranges based on spreadsheetToken and range. Any data in the ranges will be overwritten. You can write up to 5,000 rows and 100 columns of data. A single cell can't exceed 50,000 characters. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Batch get email details
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Batch get email details. Get the label, folder, summary, body, html, attachment and other information of the corresponding email by specifying the email ID Notice:Note that to obtain the abstract, body, subject, or sender address, you need to apply for the corresponding field permissions.
Batch Modify Mail Message
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Batch Modify Mail Message. Modify the mail label, the folder it belongs to, and the read and unread status in batches. You can flag, archive, and move to email spam. Moving emails into Trash folders is not supported. If necessary, please use the batch trash mail interface. Notice:Moving messages into Trash folders is not supported. If necessary, please use the Bulk Trash Mail Messages interface.
Cancel scheduled transmission
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Cancel scheduled transmission. Cancel scheduled emails, cancelled emails will become drafts
Cancel Subscribe
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Cancel Subscribe. Operates the documented `/mail/v1/user_mailboxes/{user_mailbox_id}/event/unsubscribe` resource.
Check all public mailboxes
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Check all public mailboxes. Obtains the list of public mailboxes by pages.
Create Auto Filter
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Create Auto Filter. Create Auto Filter Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing auto filter resources.
Create draft
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Create draft. Create a draft with the specified mail content.
Create Email Contacts
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Create Email Contacts. Create A Email Contact Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing email contacts resources.
Create Email Folder
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Create Email Folder. Create Email Folder Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing mail folder resources.
Create Personal Mail Template
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Create Personal Mail Template. Function: Create a reusable personal mail template in the specified user mailbox. This is useful for saving common email content for quickly sending similar emails later.
Delete Auto Filter
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Delete Auto Filter. Delete Auto Filter Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing auto filter resources. This operation is destructive.
Delete Email Contact
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Delete Email Contact. Delete An Email Contact Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing email contacts resources. This operation is destructive.
Delete Email Folder
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Delete Email Folder. Delete Email Folder Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing mail folder resources. Notice:Deleting a folder will move the emails within that folder to the deleted items folder. This operation is destructive.
Full Update Personal Mail Template
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Full Update Personal Mail Template. Update all fields of the specified mail template via a full-replace semantics (name, subject, body, attachments, recipients, etc.). The request body must contain the entire template object — any field omitted will be cleared. Call dependency: to modify only a subset of fields, call Get Personal Mail Template first to retrieve the full template, mutate it locally, then send the modified object back through this API to avoid unintended data loss.
Get Attachment Download Links
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get Attachment Download Links. Get Attachment Download Links Notice:The download links are limited to two uses and expire after two hours Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing email message resources.
Get draft content
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get draft content. Get details of a specified draft by draft ID, including the draft message, subject, body, recipients, cc recipients, bcc recipients, attachments, and security information. Use this API to display draft content before sending or load details before editing a draft.
Get Email Details
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get Email Details. Get details of a specified mail message. Notice:When accessing with app permissions, you need to apply for data permissions for mail data resources.
Get mail message send status
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get mail message send status. Query the send status of a specified email. The response returns the message business ID, delivery status for each recipient, and last update time. Before calling this API, obtain the message business ID (message_id) from the Send mail API response, then use it to query the send status.
Get Personal Mail Template
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get Personal Mail Template. Get the full detail of a personal mail template, including name, subject, body (HTML or plain text), to/cc/bcc addresses and attachments. Typically used to prefill an editor before modifying a template, or to read template content for secondary composition when sending emails.
Get Subscription Status
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get Subscription Status. Operates the documented `/mail/v1/user_mailboxes/{user_mailbox_id}/event/subscription` resource.
Get the user's signature list
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get the user's signature list. Operates the documented `/mail/v1/user_mailboxes/{user_mailbox_id}/settings/signatures` resource.
Get user email information
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Get user email information. Use to get your own email primary address under user access token
List accessible mailboxes
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. List accessible mailboxes. List accessible mailboxes, including primary accounts and public mailboxes with read and send permissions
List Auto Filters
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. List Auto Filters. List Auto Filters Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing auto filter resources.
List Email Contacts
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. List Email Contacts. List Email Contacts Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing email contacts resources.
List Email Folders
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. List Email Folders. List Email Folders Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing mail folder resources.
List Emails
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. List Emails. List mail messages in a user mailbox. Notice:When accessing with app permissions, you need to apply for data permissions for mail data resources.
list mail of mail card
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. list mail of mail card. Operates the documented `/mail/v1/user_mailboxes/{user_mailbox_id}/messages/get_by_card` resource.
Modify Email Contact's Info
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Modify Email Contact's Info. When using the tenant_access_token, it is necessary to apply for data permissions for accessing email contacts resources. Notice:When using the tenant_access_token, it is necessary to apply for the relevant data permissions.
Modify Mail message
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Modify Mail message. Modify the mail label, the folder it belongs to, and the read and unread status. You can add flags, archives, and move emails into email spam. Moving emails to deleted folders is not supported. If necessary, please use the delete mail interface. Notice:Moving messages to deleted folders is not supported. If necessary, use the Delete Messages interface.
Multi-entity search
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Multi-entity search. Multi-entity search for email-writing contacts
Query thread messages
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Query thread messages. Retrieve all message metadata in a thread by user email address and thread ID Notice:When accessing as an app, you need to apply for data permissions for mail data resources. To inquire about subject, body, abstract, and sender information, please apply for field permissions.
Reorder Auto Filters
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Reorder Auto Filters. Reorder Auto Filters Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing auto filter resources. Notice:When using this interface, you need to pass all auto filter IDs.
Search email
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Search email. Search for emails under the user's current account
Send draft
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Send draft. Send a specified draft and generate the corresponding sent message and mail thread. Use this API after creating or updating a draft to send it. The response returns the sent message ID and the thread ID. Execution sends the draft immediately and may notify recipients; this action cannot undo the send.
Send Message
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Send Message. Operates the documented `/mail/v1/user_mailboxes/{user_mailbox_id}/messages/send` resource. This operation is destructive.
Subscribe to mail events
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Subscribe to mail events. Subscribe to mail events for a user mailbox.
Update Auto Filter
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Update Auto Filter. Update Auto Filter Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing auto filter resources.
Update draft
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Update draft. Update the content of a specified draft, including subject, body, recipients, cc recipients, bcc recipients, and attachments. Use this API to continue editing a saved draft before sending it. The response returns the latest draft content.
Update Email Folder
Required connected-account bundle: email (Email). Select a connection authorized for this bundle. Update Email Folder. Update Email Folder Notice:When using the tenant_access_token, it is necessary to apply for data permissions for accessing mail folder resources.
Add chat tab
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Add chat tab. Add a custom chat tab. Provider constraints: Notice:Notice: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - Only allow to add group tabs of type doc and url. - The tab_config field is currently only valid for session tabs of type url - Only the group owner and group admins can add chat tabs when the setting Only the group owner and admins can manage tabs is turned on. - When adding doc type, the operator (the identity corresponding to the access token) needs to have the permission of the corresponding document. - When operating internal group, the operator must be under the same tenant as the group.
Add users or bots to a group
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Add users or bots to a group. Adds users or bots into a group chat. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - The bot must be available to the users to be added to the group. - When adding bots into the group,added bots need to enable the bot ability. - The bot or authorized user must be in the group. - External tenants cannot be added to internal groups. - When operating internal group, the operator must be under the same tenant as the group. - When Only group owner and group admin can add members or share group is enabled, only the group owner/admin or the bot that creates the group and has the Update the information of groups created by app scope can add users or bots to the group. - When Only group owner and group admin can add members or share group is disabled, all the group members can add users or bots to...
Batch update blocks in group announcement
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Batch update blocks in group announcement. Batch update blocks and return their updated rich text content. Provider constraints: - If the group is configured with Only group owner and group admin can edit group info, only group owners, group administrators, or robots that create groups and have the Update the information of groups created by app (im:chat:operate_as_owner) permission can update group announcement information. - If the group is not configured with Only group owner and group admin can edit group info, all group members can update group announcement information.
Determine whether a user or bot is in a group
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Determine whether a user or bot is in a group. Determines whether a user or bot is in a group based on their access_token. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - When obtaining internal group information, the operator must be under the same tenant as the group.
Create blocks in group announcement
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create blocks in group announcement. Creates a batch of child blocks for a given block and inserts them at a specific location. The return value of this API is the rich text content of the newly created child blocks. To learn about the parent-child relationship between blocks, see Group announcement overview-Basic concept. Provider constraints: - If the group is configured with Only group owner and group admin can edit group info, only group owners, group administrators, or robots that create groups and have the Update the information of groups created by app (im:chat:operate_as_owner) permission can update group announcement information. - If the group is not configured with Only group owner and group admin can edit group info, all group members can update group announcement information.
Create group
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Create a group as the connected Lark user. The authorized user becomes the creator and, when owner_id is omitted, the owner. Creates a persistent group and may invite users or bots. Provider constraints: Notice:Notes: - The bot ability needs to be enabled for the app. - This API is only used for creating a group. If you need to add users or bots into a group, refer to the Adds users or bots into a group chat. - Store apps cannot use user_id. Therefore, when using the store application to call this interface, please select open_id or union_id as the user ID type. 400 | 232057 | The operator tenant doesn't have the permission to use restricted mode. | The tenant to which the operator belongs cannot use the restricted mode. Please contact the tenant administrator. 400 | 232091 | Due to the security control requirements of this tenant, this tenant doe...
Delete a group
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete a group. Deletes a group. Provider constraints: Notice:Notes: - The bot ability needs to be enabled for the app. - If tenant_access_token is used, the bot must meet any of the following conditions to delete the group: - The bot is the group owner. - The bot is the creator of the group and has the Update the information of groups created by app scope. - If user_access_token is used, the group can be deleted only when the user is the group owner. This operation is destructive.
Delete blocks in group announcement
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete blocks in group announcement. Deletes a batch of children blocks for a given parent block at a specific location. The return value of this API is the revision ID of the group announcement after the deletion. Notice:Application frequency limit: The maximum frequency of a single application call is 5 times per second, beyond which the HTTP status code 400 and error code 99991400 will be returned. Provider constraints: - If the group is configured with Only group owner and group admin can edit group info, only group owners, group administrators, or robots that create groups and have the Update the information of groups created by app (im:chat:operate_as_owner) permission can update group announcement information. - If the group is not configured with Only group owner and group admin can edit group info, all group members can update group annou...
Delete chat tab
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete chat tab. Remove chat tags. Provider constraints: Notice:Notice: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - Only allow to delete group tabs of type doc and url. - Only the group owner and group admins can remove chat tabs when the setting Only the group owner and admins can manage tabs is turned on. - When operating internal group, the operator must be under the same tenant as the group. This operation is destructive.
Delete group administrators
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete group administrators. Deletes the specified group admins (users or bots). Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - Only the group owner can delete the group administrators. This operation is destructive.
Obtain the basic information of a group announcement
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain the basic information of a group announcement. Obtain the basic information of the specified group announcement.
Obtain the block content in group announcement
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain the block content in group announcement. Obtains the rich text content of the specified block.
Get group share link
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Get group share link. Get the share link of the specified group. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - The bot or authorized user corresponding to the access_token must be in the group specified by the chat_id parameter. - P2P chat, secret chat and team group do not support sharing links. - When the bot is deactivated or the bot exits the group, the group share link generated by the bot will also be deactivated. - When the group chat has enabled the setting that Only the group owner and group administrator can add group members/share groups , only the group owner and group administrator can get the group sharing link. - When getting internal group share link, the operator must be under the same tenant as the group.
Obtains the group member speech scopes
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtains the group member speech scopes. Obtains the group speech mode, the list of users who can speak, and more. Provider constraints: Notice:Notes: - The bot ability needs to be enabled for the app. - The bot or authorized user must be in the group.
Users or bots join a group voluntarily
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Users or bots join a group voluntarily. Users or bots join a group chat voluntarily. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - Only the public groups can be joined in. - When operating internal group, the operator must be under the same tenant as the group.
Obtain all blocks of a group announcement
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain all blocks of a group announcement. Obtains the rich text content of all blocks in a specified group announcement and return it paginated.
Obtain groups with the user or bot
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain groups with the user or bot. Get the list of groups where the user or bot represented by access_token is a member. Provider constraints: Notice:Notes: - The bot ability needs to be enabled for the app. - Be careful not to confuse the request URLs of this API and the Obtain group information API. - The obtained group list does not include P2P chat groups.
Obtain all the child blocks
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain all the child blocks. Retrieves the rich text content of all child blocks of a specified block in the group announcement and return it paginated. The document revision number is optional.
Obtain group announcement information
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain group announcement information. Obtains the group announcement in a chat, with the same format as Docs. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - When obtaining internal group information, the operator must be under the same tenant as the group.
Obtain group information
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain group information. Obtains basic information such as group name, description, profile photo, and owner ID. Provider constraints: Notice:Notes: - The bot ability needs to be enabled for the app. - The bot or authorized user must be in the group; otherwise, only the basic information such as group name and profile photo are returned. - When obtaining internal group information, the operator must be under the same tenant as the group.
Obtain group member list
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Obtain group member list. Get the list of members of the group the user/bot is in. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - This API doesn't return the bot in a group. - As the group member list returned does not contain the bot, the number of group members returned may be less than the specified page_size value. - The members that joined a group at the same time are returned together, so the number of group members returned may be greater than the specified page_size value. - When obtaining internal group information, the operator must be under the same tenant as the group.
Pull chat tabs
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Pull chat tabs. Operates the documented `/im/v1/chats/{chat_id}/chat_tabs/list_tabs` resource. Provider constraints: Notice:Notice: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - When operating internal group, the operator must be under the same tenant as the group.
Remove users or bots from a group
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Remove users or bots from a group. Removes users or bots from a group chat. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - Users or bots can remove themselves from a group under any condition (that is, leave a group voluntarily). - Only the group owner/admin and the bot that creates the group and has the Update the information of groups created by app scope can remove users or bots from a group. - Up to 50 users or 5 bots can be removed for each request. - When operating internal group, the operator must be under the same tenant as the group. This operation is destructive.
Revoke group pinning
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Revoke group pinning. Remove pinned messages or group announcements from a specified group.
Search for groups visible to a user or bot
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Search for groups visible to a user or bot. Searches for the list of groups visible to a user or bot based on the access_token used, including the groups that the user or bot is in, and groups that are open to the user or bot. The group information that can be obtained include group ID (chat_id), group name, and group description. Provider constraints: Notice:Notes: - The bot ability needs to be enabled for the app.
Sort chat tab
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Sort chat tab. Chat tab sorting. Provider constraints: Notice:Notice: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - The current message tab is fixed to the first rank and does not participate in sorting, but must be included in the request body. - When operating internal group, the operator must be under the same tenant as the group.
Specify group administrators
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Specify group administrators. Specifies users or bots as the group administrators. Provider constraints: Specifies users or bots as the group administrators. Notice:Notes: - The bot ability needs to be enabled. - Only the group owner can specify group administrators.
Update chat tab
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Update chat tab. Update chat tags. Provider constraints: Notice:Notice: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - Only allow to update group tabs of type doc and url. - Only the group owner and group admins can update chat tabs when the setting Only the group owner and admins can manage tabs is turned on. - When adding doc type, the operator (the identity corresponding to the access token) needs to have the permission of the corresponding document. - When operating internal group, the operator must be under the same tenant as the group.
Update group announcement info
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Update group announcement info. Updates the group announcement information in a chat, with the same format as Docs, newer document formats are not supported. Provider constraints: Updates the group announcement information in a chat, with the same format as Docs, newer document formats are not supported. Notice:Notes: - The bot ability needs to be enabled. - The bot or authorized user must be in the group. - The operator needs to have the read permission of the group announcement document. - When obtaining internal group information, the operator must be under the same tenant as the group. - If Only group owner and group admin can edit group info is enabled for the group, the group owner/administrators or the bot that creates the group and has the Update the information of groups created by app scope can update the group announcement. - If Only gr...
Update group information
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Update group information. Updates the group profile photo, name, description, and configuration, or assigns new group owner. Provider constraints: Notice:Notes: - The bot ability needs to be enabled for the app. - For group owners/group administrators or bots who have created a group and have the Update the information of groups created by app permission, all information can be updated. - For group members or bots that do not meet the above permission conditions: - If not enabled Only group owner and group admin can edit group .infoConfiguration, only group avatar, group name, group description, and group international name information can be updated. - If enabled Only group owner and group admin can edit group infoConfiguration, no group information can be modified. - If update the Permission to add users/bots to a group and Group sharing permiss...
Update group pinning
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Update group pinning. Updates the pinned information in a group chat. A group message or announcement can be pinned.
Updates group speech scopes
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Updates group speech scopes. Updates the settings of group speech scopes, which can be granted to all members, only admins, or only specified users. Provider constraints: Notice:Notes: - The bot ability needs to be enabled. - If the API is called with user authorization, the group speech scopes can be updated when the authorized user is the group owner. - If the API is called with tenant authorization (that is, as a bot), the group speech scopes can be updated when the bot is the group owner or the bot is the group creator, has the Update the information of groups created by app scope, and is still in the group.
Add a reaction for a message
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Add a reaction for a message. Adds a reaction of the specified type for a specified message. Provider constraints: 400 | 231020 | Due to the configuration of the tenant administrator, you cannot perform this operation on the target user temporarily. | Due to the tenant administrator's configuration, this operation cannot be performed on the target user (message sender) for the time being. Please contact the tenant administrator for assistance. 400 | 231022 | Bot has NO availability to this user. | The single chat user (the message recipient specified by the chat_id of the group chat, but the group chat type corresponding to the chat_id is single chat p2p) is not within the available range of the app bot, or is within the disabled range of the app. Solution: 1. Log in to Developer Console, find and enter the specified app details page. 2. In the le...
Delete a reaction for a message
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Delete a reaction for a message. Deletes a reaction for a specified message. Provider constraints: 400 | 231020 | Due to the configuration of the tenant administrator, you cannot perform this operation on the target user temporarily. | Due to the tenant administrator's configuration, this operation cannot be performed on the target user (message sender) for the time being. Please contact the tenant administrator for assistance. 400 | 231022 | Bot has NO availability to this user. | The single chat user (the message recipient specified by the chat_id of the group chat, but the group chat type corresponding to the chat_id is single chat p2p) is not within the available range of the app bot, or is within the disabled range of the app. Solution: 1. Log in to Developer Console, find and enter the specified app details page. 2. In the left navigation ba...
Get pins in group
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Get pins in group. Get all pin data within the specified time range in the chat. Provider constraints: Notice:Notes: - Bot ability must be enabled. - When you get pins in a group, the bot must be in the group chat. - The obtained pins are sorted in descending order by the creation time of the pin. - The default query limit of the API is 50 QPS.
List message reactions
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. List message reactions. Obtains a list of reactions of the specified type for a specified message. Provider constraints: Notice:Notes: - Bot ability must be enabled. - The message whose reaction information you need to obtain must exist and not be recalled. - To obtain the reaction for a message, the authorizer, such as the bot or the user, of the request must be in the chat where the message resides.
Pin a message
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Pin a message. Pin a specified message. Provider constraints: Notice:Notes: - Bot ability must be enabled. - When you pin a message, the bot must be in the group chat. - If the message has been pined, return the previous operation information of the pin. - Cannot pin a message that is invisible to the operator. - The pin operation for the same message cannot exceed 5 QPS.
Recall message
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Recall message. The bot recalls messages it sent or the group owner recalls messages within a group. Provider constraints: Notice:Notes: - Bot ability must be enabled, and the bot must be in the chat when recalling messages. - The bot can recall messages sent by itself in a single chat or group, and the sending time does not exceed the retractable time limit configured by the tenant administrator (the default is 24 hours). - If the bot wants to recall a message sent by one another in the group, the bot must be the owner, admin or creator of the group, and the message was sent within 1 year. - Messages sent via "Send messages in batches" API can't be recalled. - The bot can recall messages sent by itself in a single chat or group, and the sending time does not exceed the retractable time limit configured by the tenant administrator (the default is...
Send message
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Send a message as the connected Lark user to a user, email address, chat, or other supported receiver. Content must be a JSON-serialized string matching msg_type. Execution sends the message immediately and may notify recipients; this action cannot undo the delivery. Provider constraints: Notice:Notes: - Bot ability must be enabled. - To send messages to a user, the bot must be available for the user. - To send messages to a group, the bot must be in the group chat. - To avoid disturbing users, the frequency limit for sending messages to the same user is 5 QPS, and the frequency limit for sending messages to the same group is 5 QPS shared by bots in the group. 400 | 230036 | Tenant crypt key has been deleted. | The tenant encryption key has been deleted, please contact the enterprise administrator. This operation is destructive.
Unpin a message
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Unpin a message. Remove the pin of a specified message. Provider constraints: Notice:Notes: - Bot ability must be enabled. - When you unpin a message, the bot must be in the group chat. - If the message has not been pinned or has been ed, return a message that the operation was successful. - Cannot remove a pin message that is invisible to the operator. - The operation of removing a pin for the same message cannot exceed 5 QPS. This operation is destructive.
Update the message card sent by the app
Required connected-account bundle: communication_scheduling (Communication & Scheduling). Select a connection authorized for this bundle. Update the message card sent by the app. Updates the content of message cards sent by an app. Provider constraints: Notice:Notes: - Bot ability must be enabled. - If the message is updated with user_access_token, the operation user must be the sender of the card message. - Only supports updating unrecalled "Shared cards" messages for everyone, you need to explicitly declare "update_multi": true in the card's config attribute. - Updating batch messages is not supported. - The maximum text message request body cannot exceed 150KB; the maximum card and rich text message request body cannot exceed 30KB. - Only supports modifying messages sent within 14 days. - Single message update frequency control is 5QPS.
Download audio or video file of minutes
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Download audio or video file of minutes. Get the audio or video file of minutes Notice:Get the download link of minutes' audio or video file(Valid for 1 day ) through the interface for batch download
Export minutes transcript
Required connected-account bundle: docs_extended (Docs Extended). Select a connection authorized for this bundle. Export minutes transcript. Get the transcript of the minute Notice:Download transcript through the interface for batch download
Get minutes meta
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get minutes meta. Through this api, you can get a basic overview of Lark Minutes, including owner_id, create_time, title, cover picture, duration and URL.
Get minutes statistics
Required connected-account bundle: content_knowledge (Content & Knowledge). Select a connection authorized for this bundle. Get minutes statistics. Through this API, you can get access statistics of Lark Minutes, including PV, UV, visited user id, visited user timestamp.
Create OKR progress record
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create OKR progress record. Operates the documented `/okr/v1/progress_records` resource.
Delete OKR progress
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete OKR progress. Operates the documented `/okr/v1/progress_records/{progress_id}` resource. This operation is destructive.
Get OKR in bulk
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get OKR in bulk. Get OKR in batches based on OKR id Provider constraints: Notice: tenant_access_token requires additional application permissions <md-perm href = "/ssl: ttdoc/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN"> to access OKR information as an application </md-perm >
Get OKR progress records
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get OKR progress records. Obtain OKR progress record details according to ID
Get the user's OKR list
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get the user's OKR list. Get OKR list based on user id Provider constraints: Notice: tenant_access_token requires additional application permissions <md-perm href = "/ssl: ttdoc/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN"> to access OKR information as an application </md-perm >
Update OKR progress
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Update OKR progress. Operates the documented `/okr/v1/progress_records/{progress_id}` resource.
Upload progress record image
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Upload progress record image. Upload progress record image. After successfully calling this interface, you can continue to call Create OKR Progress Record or Update OKR Progress Record, and pass the returned url parameter and file_token parameter into the imageList parameter.
Document Search
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Document Search. This interface is used to search cloud documents currently visible to the user based on search keywords (query).
Search Message
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Search Message. Users can search for visible messages by keyword, and the visibility is consistent with the search in the suite.
Cancel user migration
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Cancel user migration. Cancel user migration. This operation can only be done for users whose migration has not been started .
Get user migration status
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get user migration status. Get the current migration status of a single user.
Migrate users
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Migrate users. Migrate users' data to the specified geographic location.
Get user migration status in batches
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get user migration status in batches. Pass in a list of user IDs to get user migration status in batches.
Get a list of geographic locations
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get a list of geographic locations. Get a list of geographic locations available to your organization.
Obtain device information via user authorization
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Obtain device information via user authorization. Obtain device information for the corresponding authorized endpoint—including the device authentication code, current device ownership, and current trust status—upon user authorization.
Add Custom Field to Resource
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Add Custom Field to Resource. Add custom fields to a resource. Currently resource types support tasklist. A custom field can be added to multiple tasklists. After adding, the tasklist can display the value of the custom fields of the task, by which functions such as filtering and grouping based on the field are available. Provider constraints: If the settings of the custom field are updated, all fields added by the field can receive the update and display it accordingly. Notice:Adding a custom field to a resource requires edit permission of both the custom field and the resource.
Add Dependency
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Add Dependency. Add one or more dependencies to a task. You can add prev-dependencies or next-dependencies of tasks. If a task with dependencies is in the same tasklist, you can show its dependencies through the Gantt View of the tasklist. Provider constraints: Note: The task_guid of added dependencies cannot contain duplicated task_guid, nor can the current task be added as its own dependency. Attempts to add an existing dependency are automatically ignored and will get a successful response. Notice:Adding a task dependence requires the invocation identity to have edit permissions for the current task and all tasks added as dependencies.
Add Task Member
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Add Task Member. Add assignees or followers to a task. Multiple members can be added at once. The list of task members after adding is returned in the task field of response. Provider constraints: * For the format of member, please refer to the " How to represent members of tasks and tasklists?" section in Feature Overview . * Available member types: "user", "app" * Available member roles: "assigee", "follower" * If the member to be added is already in the task, it is automatically ignored. Notice:Adding task members requires edit permissions on the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
Add Task Members
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Add Task Members. Add one or more members to a tasklist. Members can be set by setting members fields. For the format of member, please refer to the " How to represent members of tasks and tasklists?" section in Feature Overview .
Add Task Reminder
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Add Task Reminder. Add a reminder for a task. A reminder is a moment calculated based on the task due time. In order to set a reminder, the task must first have a due. You can set the due when Create Task, or by Update Task set a deadline. Provider constraints: If the current task already has a reminder, to update the settings of the reminder, you need to call the Remove Task Reminder api to remove the original reminder. Then call this interface to add reminders. Notice:Requires edit permission for the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
Add Task to Tasklist
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Add Task to Tasklist. Add a task to a tasklist. Returns the details of the task, including all tasklist information where the task belongs to.
Create Activity Subscription
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Activity Subscription. Create an activity subscription for a tasklist. Each subscription can contain multiple subscribers (currently only group chats are supported). Provider constraints: When necessary, you can create supscription by which no notification messages will be sent by setting disabled to "true". Notice:Creating a subscription for the task requires the calling identity to have the edit permission of the tasklist and can access the chats in the subscribers. If the calling identity loses the tasklist edit permissions or accessibility of the chats after adding the subscription, the subscription will remain in place until deletion.
Create Comment
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Comment. Create a comment for a task, or reply to a comment for that task. Provider constraints: To create a reply comment, you need to set the reply_to_comment_id field at creation time. The comment being replied to and the new comment must belong to the same task. Notice:Creating comments for task requires read permission for this task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
Create Custom Field
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Custom Field. Create a custom field and add it to a resource (currently resources only support "tasklist"). To create a custom field, you must provide the field name, type and corresponding field settings. Provider constraints: which means creating a "priority" single select custom field with 3 options: high, mid, low,with color set to each of them. Notice:Creating custom fields on a resource requires edit permissions for that resource.
Create Custom Field Option
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Custom Field Option. Add a custom option to single/multi select fields. A single/multi select field supports up to 100 options.
Create Section
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Section. Create a section for a tasklist or "Owned Tasks". You may provide a name and optional locating parameters. If no locating parameters are specified, the new section will be placed at the end of the sections of the specified resource.
Create Subtask
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Subtask. Create a subtask for a task. Provider constraints: The api function is exactly the same as the Create Task except that the parent task GUID needs to be provided. Notice:Creating a subtask requires editing permissions to the parent task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
Create Task
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Task. This API can create a task. When creating a task, it supports filling in the basic information of the task (such as title, description, person in charge, etc.). In addition, it can also set the start time of the task, deadline reminders and other conditions. In addition, you can pass in the tasklists field to add new tasks to multiple lists.
Create Tasklist
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Create Tasklist. Create a tasklist. Tasklist can be used to organize and manage multiple tasks belonging to the same project.
Delete Activity Subscription
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete Activity Subscription. Delete an activity subscription by giving a tasklist GUID and its subscription GUID. The deleted subscription is not recoverable. Notice:Deleting a subscription requires edit permission to the tasklist. Provider constraints: Delete an activity subscription by giving a tasklist GUID and its subscription GUID. The deleted subscription is not recoverable. Notice:Deleting a subscription requires edit permission to the tasklist. This operation is destructive.
Delete Attachment
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete Attachment. Providing an attachment GUID, delete the attachment. After deletion, the attachment cannot be recovered. Notice:Deleting an attachment requires the calling identity to have the edit permission of the resource to which the deleted attachment belongs, or the calling identity is exactly the the attachment uploader. Provider constraints: Providing an attachment GUID, delete the attachment. After deletion, the attachment cannot be recovered. Notice:Deleting an attachment requires the calling identity to have the edit permission of the resource to which the deleted attachment belongs, or the calling identity is exactly the the attachment uploader. This operation is destructive.
Delete Comment
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete Comment. Delete a comment. This operation is destructive.
Delete Section
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete Section. Delete a section. The tasks in the deleted section will be moved to the default section of the resource to which the deleted section belongs. This operation is destructive.
Delete Task
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete Task. Delete a task. Provider constraints: Tasks can no longer be restored after deletion. Notice:Deleting a task requires edit permissions on the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview. This operation is destructive.
Delete Tasklist
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete Tasklist. Delete a tasklist. Provider constraints: After a tasklist is deleted, no action can be performed on the tasklist and the tasklist can no longer be accessed. A deleted tasklist cannot be recovered. Notice:Deleting a tasklist requires tasklist manage permissions. Please refer to the "How are tasklist authorized?" section in Tasklist Features Overview . This operation is destructive.
Get Activity Subscription
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Activity Subscription. Providing a tasklist GUID and tasklist's subscription GUID, get the details of the subscription data, including name, subscriber, list of event keys that can be notified, etc. Notice:Obtaining a dynamic subscription requires read permission on the tasklist. Provider constraints: Providing a tasklist GUID and tasklist's subscription GUID, get the details of the subscription data, including name, subscriber, list of event keys that can be notified, etc. Notice:Obtaining a dynamic subscription requires read permission on the tasklist.
Get Attachment
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Attachment. Providing an attachment GUID, get the detail of the attachment, including GUID, name, size, uploaded time, temporary downloadable url, etc. Notice:Getting attachment requires read permission to the resource to which the attachment belongs. Provider constraints: Providing an attachment GUID, get the detail of the attachment, including GUID, name, size, uploaded time, temporary downloadable url, etc. Notice:Getting attachment requires read permission to the resource to which the attachment belongs.
Get Comment Details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Comment Details. Given the ID of a comment, return the details of the comment, including information such as content, creator, creation time and update time. Notice:Getting comment of a task requires read permission of the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview. Provider constraints: Given the ID of a comment, return the details of the comment, including information such as content, creator, creation time and update time. Notice:Getting comment of a task requires read permission of the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
Get Custom Field
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Custom Field. By specifying a custom field GUID, get its detailed information. Notice:Obtaining a custom field requires read permission for the custom field. Provider constraints: By specifying a custom field GUID, get its detailed information. Notice:Obtaining a custom field requires read permission for the custom field.
Get Section
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Section. Gets the details of a section, including name, creator, etc. If the section belongs to a tasklist, the summary of the tasklist is also returned. Notice:Requires read permission of the tasklist if the section belongs to a tasklist Provider constraints: Gets the details of a section, including name, creator, etc. If the section belongs to a tasklist, the summary of the tasklist is also returned. Notice:Requires read permission of the tasklist if the section belongs to a tasklist
Get Task Details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Task Details. This api is used to obtain task details, including task summary, description, time, members and other information. Notice:Getting the task details requires the calling identity to have read permissions on the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview. Provider constraints: This api is used to obtain task details, including task summary, description, time, members and other information. Notice:Getting the task details requires the calling identity to have read permissions on the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
Get Tasklist Details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Tasklist Details. Get the details of a tasklist, including list name, owner, list members, etc. Notice:Require tasklist read permission. Please refer to the "How are tasklist authorized?" section in Tasklist Features Overview .
Get Tasks of Tasklist
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get Tasks of Tasklist. Gets the summary of tasks belonging to a tasklist.
List Activity Subscription
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Activity Subscription. Given the tasklist GUID, list its all activity subscriptions. Results are sorted by subscription create time. Notice:List subscription requires read permissions to the tasklist. Provider constraints: Given the tasklist GUID, list its all activity subscriptions. Results are sorted by subscription create time. Notice:List subscription requires read permissions to the tasklist.
List Attachment
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Attachment. List all attachments of a resource. The returned attachments supports paging and are sorted by upload time. Provider constraints: Each attachment will return a temporary url available for download. Url is available for up to 3 minutes and can only be used for up to 3 times. If the limit is exceeded, you need to obtain a new temporary url through this api. Notice:Get the attachment list of the task requires read permission for the task.
List Comments
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Comments. Given a resource, returns a list of comments for that resource. Provider constraints: Pagination is supported. Comments can return data in positive order (asc, oldest to newest) or reverse order (desc, oldest to newest) of creation time. Notice:Listing comment of a task requires the read permission of the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
List Custom Fields
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Custom Fields. Get a list of custom fields accessible to the calling identity. If the resource_type and resource_id parameters are not provided, all custom fields accessible to the calling identity are returned. Provider constraints: If resource_type and resource_id are provided, the custom fields under that resource are returned. Currently resource_type only supports "tasklist", in which case resource_id should be a tasklist GUID.
List Sections
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Sections. Get a list of section. Paging is supported. The returned results are sorted in the order in which the sections are placed on the UI. Notice:Listing sections requires read permission on the resource. Provider constraints: Get a list of section. Paging is supported. The returned results are sorted in the order in which the sections are placed on the UI. Notice:Listing sections requires read permission on the resource.
List Subtasks of Task
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Subtasks of Task. Get all subtasks of a task.
List Tasklists
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Tasklists. List all the tasklists the calling identity has read permission.
List Tasklists of Task
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Tasklists of Task. List the all lists where a task belongs to, including the tasklist GUID and section GUID. Provider constraints: Only the tasklists that calling identity has read permission will be returned. Notice:Requires the calling identity to have read access to the task. Please refer to the "How are Tasks Authorized?" section in Task Features Overview.
List Tasks
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Tasks. List all tasks of a specific type based on the calling identity. Paging is supported.
List Tasks of Section
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List Tasks of Section. List tasks of a section. Paging is supported. Tasks are returned in the order as "custom" order of UI. This API supports simple filtering. Notice:Require read permission of the resource to which the section belongs.
List The Tasks That Are Relevant To Me
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. List The Tasks That Are Relevant To Me. Get the task center: a list of tasks I'm responsible for, tasks I'm following, tasks I created, and tasks I assigned, sorted in ascending order of task update time.
Patch Activity Subscription
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Patch Activity Subscription. Update an activity subscription by providing a tasklist GUID and a subscription GUID. When updating, fill in all field names to be updated in the update_fields field, and fill in the new value of the field in the activity_subscription field.
Patch Comment
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Patch Comment. Update a comment. Provider constraints: Currently only the "conent" field for updating comments is supported. Notice:Updating comments requires the read permission of the comment attribution task, and can only update comments created by yourself. See "How are Tasks Authorized?" section in Task Feature Overview.
Patch Section
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Patch Section. Update a section. you can update section's name and postion.
Patch Task
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Patch Task. This api is used to update the summary, description, due, etc. of a task.
Patch Tasklist
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Patch Tasklist. Update a tasklist. You can update the name and owner of the tasklist. Provider constraints: This api cannot be used to update members of the tasklist and add or delete tasks in the tasklist. * To add or delete members from the tasklist, you can use the Add Tasklist Member and Remove Tasklist Member api. * To add or delete tasks in the tasklist, you can use the Add Task to Tasklist and Remove Task from Tasklist api. Notice:Updating the tasklist name requires edit permission. Updating owner must have manage permission. Please refer to the "How are tasklist authorized?" section in Tasklist Features Overview .
Remove Custom Field From Resource
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Remove Custom Field From Resource. Remove a custom field from the resource. After removal, the resource will no longer be able to use the field. Currently, only resource type "tasklist" is supported. Provider constraints: Note that custom fields are authorized through tasklist. If a custom field is removed from all associated tasklists, it means that any calling identity can no longer access the that custom field. Notice:Requires edit permission for the resource.
Remove Dependency
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Remove Dependency. Removes one or more dependencies from a task. You can remove dependencies by passing their task_guid.
Remove Task from Tasklist
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Remove Task from Tasklist. Remove a task from a tasklist. Returns task details. Provider constraints: If the task is not in the tasklist, the api will return success. Notice:Requires edit permission for the tasklist. Please refer to the "How are tasklist authorized?" section in Tasklist Features Overview .
Remove Tasklist Members
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Remove Tasklist Members. Removes one or more members of the tasklist. Members to remove can be specified by setting members field。For the format of member, please refer to the " How to represent members of tasks and tasklists?" section in Feature Overview .
Remove Task Member
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Remove Task Member. Remove task members. Multiple members can be removed at one time. The assignees and followers of the task can be removed. When removing, if the member to be removed is not one of this task members, it will be automatically ignored. This api returns the task data after removing the member, including the list of task members after removal. Notice:Removing a task member requires the task's edit permission. Please refer to the "How are Tasks Authorized?" section in Task Features Overview. Provider constraints: Remove task members. Multiple members can be removed at one time. The assignees and followers of the task can be removed. When removing, if the member to be removed is not one of this task members, it will be automatically ignored. This api returns the task data after removing the member, including the list of task members after...
Remove Task Reminder
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Remove Task Reminder. Remove a reminder from the task. Provider constraints: If the reminder to be removed does not exist in the first place, this interface will directly return success. Notice:Requires editing permission for the task. See How is the task authenticated?.
Search Task
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Search Task. Search for task information using task keywords, including task name, task link, task ID, and task description.
Search Tasklist
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Search Tasklist. Search for information about a Tasklist by keywords, including Tasklist name, Tasklist ID, Tasklist link, and Tasklist description.
Set Parent Task
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Set Parent Task. Manage the parent-child relationship of tasks, support setting the parent task of a task, or convert a task into an independent task.
Task Update Event Subscription
Required connected-account bundle: workflow_extended (Workflow Extended). Select a connection authorized for this bundle. Task Update Event Subscription. - Subscription Scope - Using application identity, subscribe to change events for tasks currently managed by the application. - Using user identity, subscribe to change events for tasks created, managed, or followed by the current user. Notice:Event Definition:Task Update Event
Update Custom Field
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Update Custom Field. Update the name and settings of a custom field. When updating, fill in all the task field names to be updated in the update_fields, and fill in the new value in the custom_field. Custom field type is not allowed to change. Only their settings can be modified according to the type. Provider constraints: If you want to update only one single option, or want to set the is_hidden of an option separately, this API cannot do that. But you can use the Update Custom Field Options API to do it. Notice:Updating a custom field requires edit permissions to the custom field.
Update Custom Field Option
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Update Custom Field Option. Update the a custom field option by specifying the field GUID and option GUID. The field to be updated must be of a single or multi-select type, and the option to be updated must belong to that custom field.
Upload Attachment
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Upload Attachment. Upload attachments for a resource. This API supports uploading up to 5 attachments at a time. The size of each attachment cannot exceed 50MB. Attachment file's format is not limited. Provider constraints: Currently the resource type only supports "task", with which resource_id need to be filled in a task GUID. Notice:Uploading attachments for a task requires edit permissions for the task.
Authorize recording files
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Authorize recording files. Authorizes a meeting's recording files to an organization/user or makes them public to the public network.
Delete a schedule
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Delete a schedule. Deletes a schedule. This operation is destructive.
Download export file
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Download export file. Operates the documented `/vc/v1/exports/download` resource.
End a meeting
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. End a meeting. Ends an ongoing meeting. This operation is destructive.
Export meeting details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Export meeting details. Export meeting details. For specific permission requirements, please refer to "Resource introduction".
Export meeting room reservation data
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Export meeting room reservation data. Export meeting room reservation data. For specific permission requirements, please refer to "Resource introduction".
Export participant details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Export participant details. Export a list of participant details for a conference. For specific permission requirements, please refer to "Resource introduction".
Export participant meeting quality data
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Export participant meeting quality data. Export audio and video & share quality data of a participant in a conference , please refer to "Resource introduction" for specific permission requirements.
Get a list of active user meetings
Required connected-account bundle: video_interactive (Video Interactive). Select a connection authorized for this bundle. Get a list of active user meetings. Query all meetings that a specified user is currently participating in. The response includes active meetings with key information such as meeting number, meeting ID, and meeting title. Notice:This capability is currently in limited rollout and is not yet generally available. To request access or confirm availability, contact technical support
Get a list of meeting events
Required connected-account bundle: video_interactive (Video Interactive). Select a connection authorized for this bundle. Get a list of meeting events. Get the event list of a meeting, including participant join or leave events, speech events, chat events, and sharing events. Before calling this API, complete the prerequisite for the authentication identity: with a user_access_token, the authorized user must already be in the target meeting and obtain the meeting_id from Get a list of active user meetings; with a tenant_access_token, the app Bot must first join the target meeting by calling Join a meeting and use the meeting_id returned by that API. Notice:This capability is currently in limited rollout and is not yet generally available. To request access or confirm availability, contact technical support
Get meeting details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get meeting details. Operates the documented `/vc/v1/meeting_list` resource.
Get participant details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get participant details. Operates the documented `/vc/v1/participant_list` resource.
Get participant meeting quality data
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Get participant meeting quality data. Operates the documented `/vc/v1/participant_quality_list` resource.
Invite participants
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Invite participants. Invites participants to a meeting. Execution sends or applies the participant invitations immediately and may notify invitees; this action cannot undo those invitations.
List meetings of same meeting number
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. List meetings of same meeting number. Obtains the meeting brief list associated with the meeting number for a specified time period (within 90 days).
Obtain an active meeting
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain an active meeting. Obtains a scheduled meeting that is currently active.
Obtain a schedule
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain a schedule. Obtains details about a schedule.
Obtain meeting details
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain meeting details. Obtains the detailed data of a meeting.
Obtain recording files
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Obtain recording files. Obtain recording files of a meeting.
Operate Meeting Countdown
Required connected-account bundle: video_interactive (Video Interactive). Select a connection authorized for this bundle. Operate Meeting Countdown. This API is used to operate the in-meeting countdown. It supports custom durations, setting, extending, ending early, and closing the countdown window. It is suitable for meeting moderation scenarios. Contract confidence is medium because this operation is documented but absent from the official SDK snapshot.
Query export task results
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Query export task results. View the progress of asynchronous export.
Schedule a meeting
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Schedule a meeting. Creates a meeting scheduling.
Send an in-session message
Required connected-account bundle: video_interactive (Video Interactive). Select a connection authorized for this bundle. Send an in-session message. Sends an in-session message to the specified video meeting. Notice:This capability is currently in limited rollout and is not yet generally available. To request access or confirm availability, contact technical support Notice:Prerequisite: The bot must have joined the target meeting. Call the Join a meeting API first. Execution sends the in-session message immediately to meeting participants; this action cannot undo the delivery.
Set meeting host
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Set meeting host. Sets a host for a meeting.
Start recording
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Start recording. Start recording in a meeting.
Stop recording
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Stop recording. Stop recording in the meeting.
Update a schedule
Required connected-account bundle: work_organization (Work Management & Organization). Select a connection authorized for this bundle. Update a schedule. Updates a schedule.
Get connected
Add Lark to your Slack in two minutes.
No workflows to wire up. Turn on the tools you already use, and your agent gets to work.
Add to Slack
1
Add Sokko to Slack
One click from the Slack marketplace. Your whole team gets Sokko at once.
2
Connect your tools
Sokko works with 1,000+ apps and any MCP server.
Martin
9:53 AM
@Sokko
What can you do with Lark?
3
Put Sokko to work
@mention Sokko in any channel and it gets going. Minutes, not a weekend.
Questions, answered.
Sokko is an AI assistant that lives in your Slack. Connect your apps, ask for what you need in plain language, and Sokko takes the work off your plate.
Composio supports this app with a custom OAuth client. Sokko's automatic connection flow does not configure that client yet. Check the provider's authentication documentation or a custom MCP route.
No. There's nothing to build or configure. You ask Sokko in Slack the same way you'd ask a colleague, and Sokko handles the rest.
Yes. Ask once and tell Sokko when to repeat it, like every Monday at 9am, and it becomes a routine that runs without you.
Read and act on data in Lark, and trigger workflows when something changes there. Tell Sokko the outcome you want and it handles the rest.
Yes. Sokko connects to 1,000+ apps and any MCP server, so you can ask for tasks that span Lark and the rest of your stack in a single request.