This article provides an overview of Open Platform. For more details on this product, see Developer Documentation.

I. Intro 

Feishu provides comprehensive and in-depth capabilities as an information hub, integrating with existing IT ecosystems of organizations, supporting and complementing existing IT systems, enhancing digital efficiency, and helping businesses to build an all-in-one collaboration platform. This allows employees to focus on their work, simplifies tasks, and provides IT teams with agile development and a delightful experience.

Integrating Feishu's open platform with existing systems can quickly break down system barriers, making information transmission more efficient. Organizations can utilize various Feishu modules such as documents, contacts, messages, and user profiles in both existing systems and newly developed applications, enabling efficient collaboration beyond Feishu.

II. Diverse app features for various scenarios

Based on application features, Feishu apps can be classified into bots, web apps, and add-ons. Different application features support different capabilities. For more details, see Application types and capabilities.

Feature
Bot
Web app (H5)
Add-on
Scenario
A Bot is an application that interacts with users through conversations. By integrating Feishu Calendar, Approval, documents, and third-party business systems, Feishu can aggregate notifications from various applications (such as monitoring alerts, task reminders, and data reports) in one place. It also supports automated group management, monitoring, and responding to user messages.
For more details, see Bot overview.
A web app is an application developed using H5, which can run within the Feishu client. By leveraging Feishu's open APIs (such as identity authentication, contacts, and Docs), organizations can deeply integrate existing applications with Feishu's ecosystem and quickly migrate applications using the SSO single sign-on system.
For more details, see Web app overview.
An add-on is a unique and lightweight functional block developed by Feishu, serving as an information unit carrier that combines rendering, interaction, and data. It ensures smooth information flow and consumption within the Feishu suite. Through add-ons, IT and third-party service providers can develop applications for various scenarios, enabling document collaboration and organization workflow integration, thereby enhancing the capabilities of the Feishu suite and improving efficiency.
For more details, see Docs add-on overview and Base extensions overview.

III. Comprehensive open capabilities for daily office work

The Feishu Open Platform currently provides over 2,500 standardized server-side APIs (see API list for details) to support seamless integration of core modules like Docs, Base, Contacts, Messenger, groups, and Calendar. These APIs enable organizations to quickly build collaborative office solutions through existing system upgrades or new application development, achieving efficient collaboration and process integration both internally and externally.

Messaging and group chat API

Feishu provides a series of APIs for instant communication scenarios. By creating Feishu bots and leveraging the Messaging and group APIs, organizations can:

Send various types of Feishu messages such as text, rich text, images, files, interactive Feishu cards, videos, audios, and emojis.

Manage groups, such as creating groups, and adding usrs or bots to the group.

Scenario
Description
API and reference examples
Automatic group creation for operations alerts
Organizations can use Feishu’s capabilities to automatically create project-specific groups for alerts. For example:
Push alert notifications directly to the group.
Collaborate and synchronize progress in the group, with records available for review later.
Automatically rename groups to "Resolved" once issues are addressed.
API/Capabilities:
Create a group
Update group information
Add users or bots to a group
Send message
Tutorials: Bot Auto Sends Group Alarm
Customer stories:
Feishu's unified alert solution guarantees reliable services from notification to efficient collaboration
Automated ticket/feedback flow
Take the ticket processing scenario as an example. Leveraging existing API capabilities enables a fully automated closed-loop workflow, from group creation and progress updates to information archiving, significantly reducing manual intervention.
When internal members initiate inquiries or feedback through designated channels, bots can quickly create group chats and add relevant personnel.
The created group chats can automatically set group names, avatars, and other basic information according to predefined rules, helping members understand the chat topics clearly (for instance, matching different avatars based on issue types for easy identification).
After resolution, bots can automatically retrieve the complete conversation history for important information collection and archiving.
Bots can dispatch the group chat after archiving to avoid excessive useless groups.
API/Capabilities:
Create a group
Update group information
Get chat history
Customer stories: Smart dispatch of O&M tickets, accurate and smooth circulation of info

Contacts API

The Contacts APIs allow secure management of an organization's directory, including:

Viewing the organizational structure

Adding or updating user profiles

Maintaining associations between users and departments

Maintaining associations between users and user groups

Scenario
Description
API and reference examples
HR system integration 
By integrating HR processes with Feishu, organizations can:
Automate employee onboarding, promotion, and resignation workflows.
Sync personnel data in real time to eliminate manual updates.
Provide clearer guidance for approvals and transfers.
API/Capabilities:
Create a department
Modify department information in part
Create a user
Send message
Tutorials: Sync Corp. Org Structure with Feishu
Customer stories: Integrating your HR system with Feishu makes managing HR tasks even easier

Docs API

Scenario
Description
API and reference examples
Automated weekly/monthly reports
Automated weekly and daily reports can standardize report formats, automate reminders and notifications, improve report quality and timeliness, and save manpower. By using Feishu's Docs capabilities, teams can:
Create a new weekly report from a template and grant team members editing permissions
Automatically archive the weekly report to a specified node in the wiki
Send group messages through group chat bots to notify everyone to update the current week's report content
Docs API
Get Root Folder Meta
Get Folder Children
Obtain Metadata
Copy a Doc or Sheet
Add permissions
Add Wiki space members
Move cloud document to Wiki
Message and group API:
Obtain groups where the user or bot is a member
Send message
Tutorials:
Manage Weekly Report with Docs
Sales statistics using spreadsheets
Using the open capabilities of Feishu Sheets, external sales data can be synchronized into the spreadsheet for total calculation:
Create a spreadsheet through API
Write external data, add SUM formulas, and set styles
Set document permissions for specified users
Docs API:
Get Root Folder Meta
Create a spreadsheet
Obtain Spreadsheet Metadata
Write data to multiple ranges
Batch Set Cell Style
Add permissions
Tutorials:
Track Sales Statistics with Spreadsheets
Daily to-do reminders from Wiki reports 
Extract to-do items (tasks, assignees, and deadlines) from the latest weekly report and send automated reminders through a group chat.
Login API:
Get custom app tenant_access_token
Docs API:
Get the list of child nodes in Wiki
Get Wiki node information
Get Document
Message and group API:
Obtain groups where the user or bot is a member
Send message
Agile project management with Base
Use Base for agile project management and create a public calendar for project iteration cycles, which is available for subscription by the entire team.
Login API:
Get custom app tenant_access_token
Docs API:
List records
Update records
Create records
Create table
List fields
Create field
Update field
Calendar API:
Create a shared calendar
Send message
Tutorials:
Manage Agile Project with Base
Replace links after document migration
In data migration, you can import local files into Feishu Docs, identify outdated links, and correct them with new links after the import.
Login API:
Get custom app tenant_access_token
Docs API:
Get Root Folder Meta
Upload a file
Create an import task
Query import task result
Update document sharing settings
Obtain all blocks of a document
Update a block
Tutorials:
Replace Links after Doc migration

Calendar API

Feishu's Calendar API enables management of calendars, events, and availability. By calling the Calendar API, you can achieve the following features:

Scheduling events and booking meeting rooms

Inviting participants, including Feishu users or external guests

Viewing user availability

Syncing user leave status

Binding and unbinding Exchange accounts

Scenario
Description
API and reference examples
Meeting management
Organizing meetings, especially large ones (for example, more than 50 attendees), often involves tedious manual coordination: checking availability, reserving rooms, and tracking attendance, which leads to inefficiencies. Feishu's intelligent meeting solution integrates schedules, meetings, and rooms into a unified workflow:
Real-time updates for events, room bookings, and attendee status.
Auto-check participant availability and room conflicts.
Reduce no-shows and double-bookings.
API/Capabilities:
Query availability of the primary calendar
Create event
Create event invitees
Update Event
Create event invitees
Delete event invitees
Delete Event
Customer stories:
Feishu smart meeting makes managing meetings easy
Leave status sync
Approved leave requests often fail to sync with internal tools, causing misaligned work assignments during an employee’s absence. Now, you can integrate Feishu with your HR system to sync employees' leave information in real-time within Feishu. On the day of leave, a "Leave" tag will appear on the employee's profile and calendar, making it easier for others to know and adjust work arrangements in time.
API/Capabilities:
Create Timeoff Event
Delete Timeoff Event
Tutorials: Auto-fetch Calendar Events
Customer stories:
Real-time on-leave status update for effortless and effective communications

IV. Rich Web components, quick integration with organization's own systems

Feishu Open Platform, based on Feishu's unique collaboration features, also offers a series of web components to help organizations quickly connect their systems with Feishu, allowing them to seamlessly integrate Feishu's collaboration features into their systems at a low cost. This enables capabilities such as Docs, member profiles, comments, and more.

Feature
Docs Component
Member Profile Component
Selector Component
Intro
Docs Component allows developers to embed Docs into business systems, enabling organizations to have online document capabilities. Users can collaboratively edit, comment on documents, and manage user permissions within the embedded system. Lightweight integration of Docs can link different systems together.
Member profile component helps team members better understand each other, reducing communication costs. By calling the member profile component, you can present Feishu member profiles on web pages, supporting the initiation of Feishu chats, viewing OKRs, and more through buttons on the profiles. This component supports multiple languages (Chinese, English, Japanese, and so on) and offers both light and dark mode configurations.
Selector Component can be used for scenarios where you need to search and select personnel, groups, documents, and so on, matching keywords with corresponding results and supporting mixed displays of various data types. This component supports multiple languages (Chinese, English, Japanese, and so on) and offers both light and dark mode configurations.
Illustration
Integrate Feishu document editing, commenting, and user permissions management capabilities into organization applications for more efficient content collaboration. Lightweight integration of Docs leverages robust collaboration capabilities to link your systems together, enabling simultaneous effects in multiple locations from a single edit.
The above image shows a project management system (browser webpage) within an organization:
When users want to learn about the person in charge, they can click that person's profile to open the member profile page and view their basic information.
If users have questions about the project, they can directly click Message on the member profile page to quickly open a Feishu chat session with the person in charge, greatly enhancing project collaboration efficiency.
The above image shows an information management system (browser webpage) within an organization:
When users want to manage authorization for a specific piece of information, the authorization popup includes a "search box" component where they can enter keywords to search for personnel or groups.
Upon completing the search, they can select the relevant personnel or groups to finalize the authorization.

V. Flexible integration modes to meet different development backgrounds

Developers can flexibly choose different integration methods based on their background and experience. Besides fully code-based API calls and integrations, you can also opt for low-code methods to quickly build applications or zero-code visual process orchestration to achieve business integration. With the AnyCross Integration Platform and aPaaS low-code platform, developers can efficiently complete business development while reducing complexity and cost.

Development mode
Low-Code development
Low-Code development
Zero code development
Build AI Agents
Platform capabilities
Feishu Integration Platform (AnyCross) provides organizations with standard and efficient system integration capabilities, allowing them to create powerful integration solutions and realize comprehensive data communication across their business systems. This makes integration more standardized, secure, and simple.
Feishu Low-Code Platform (aPaaS) offers organizations full-code underlying capabilities and a low-code development experience. It empowers every developer to become a full-stack engineer, enabling the delivery of complex business systems with greater agility and user-friendliness.
Feishu Base provides capabilities such as views, dashboards, forms, automation, and plugins to customize exclusive business systems.
Feishu Aily focuses on large language models (LLM) to offer AI skill orchestration, knowledge data processing, effect optimization, and continuous operation capabilities. This enables users to efficiently develop professional organization-level intelligent applications and publish them in Feishu, Web, and other channels with a single click.
Illustration

VI. Customer stories

During digital transformation, organizations often face core challenges such as system fragmentation, data silos, and inefficient processes. By integrating CRM, OA, ERP, and other systems through our rich and flexible open capabilities, we can achieve business process automation, real-time data connectivity, and cross-department collaboration, helping organizations reduce costs and increase efficiency. Below are some typical customer cases. For more customer cases, see Customer stories.

Scenario
Business pain points
Solution
Financial approval management
Every day, you have a large number of processes that require your approval. It is not difficult to find the documents and click approve in the business system, but the challenge lies in the disconnection between process approval and corresponding execution. Your day is consumed in the endless cycle of confirming applicants, validating the rationale for applications, manually executing operations in various systems, and providing feedback to applicants.
How POIZON uses Feishu's open capabilities to achieve intelligent approval management
Sales knowledge collaboration
Your daily work involves supporting store sales, deliveries, and after-sales service needs. During customer service, you often need to look up professional terms and the latest policy knowledge. For customized customer needs and complex issues, you sometimes need to connect with expert support. How can you quickly access the latest and most comprehensive knowledge and connect with the most relevant experts for timely support?
Automation solution in Li Auto Inc.
Enterprise business operations
You are responsible for store operations, supply chain, and marketing activity management, often needing to query and analyze data. When on the go, accessing business systems via a mobile phone is extremely difficult, let alone hoping to obtain data in real-time and capture abnormal data as early as possible.
How AUNTEA JENNY leverages robots to make business data readily available

VII. Quick start guide

You can follow the tutorials below to quickly experience application development on the Feishu Open Platform and understand the specific implementation effects.

Call a server API (Send message)
Call a server API (Create Base app)
Develop an echo bot
Develop a card interactive bot
Embed a web app into Feishu Workplace
Develop H5 (Node.js)

VIII. Development tools

Feishu provides comprehensive tool support from research to publishing. Developers can flexibly use and combine these tools according to their needs, reducing development barriers. For more resources, see Developer tools overview.

AI Assistant

Open Platform AI Assistant is a full-process efficiency tool designed specifically for developers, covering core scenarios throughout the development lifecycle. Currently, it supports three core capabilities:

Concept explanation: When developers encounter complex concepts that are difficult to understand, the AI assistant can quickly index and integrate relevant information, providing clear and comprehensible explanations to help developers reduce cognitive load and quickly get started. Click to try.

Solution design: During the requirements research phase, it provides structured implementation ideas and complete implementation paths including example codes, guiding developers to better plan and execute projects, thereby improving development efficiency. Click to try.

Error diagnosis: When developers encounter errors while calling server-side APIs, the AI assistant can diagnose and analyze based on logid or error information and provide complete and clear repair suggestions, helping developers efficiently solve problems on their own. Click to try.

API Explorer

API Explorer is a one-stop Feishu application development tool designed to enhance the efficiency of interface debugging. With the API Explorer, you can quickly complete server-side interface calls without writing code. Additionally, the explorer offers the following features to improve the efficiency of interface debugging:

Automatic authentication token retrieval: Bind your application to obtain tokens in one click without needing to send additional requests each time you debug.

Built-in application permission request: Easily see the permissions required to call the API without needing to navigate to the backend, and quickly apply for these permissions within the explorer.

Interface debugging example code: Provides multi-language example codes that you can quickly copy and reuse in your business code with one click.

Server-side SDK

The Feishu Open Platform offers a series of atomic server-side APIs to implement a variety of functions. However, while coding, you need to consider additional tasks such as obtaining and maintaining access tokens, data encryption and decryption, and request signature validation. The lack of semantic descriptions for function calls and support for type systems may also increase coding burdens.

To address these issues, the Feishu Open Platform provides server-side SDKs to improve the coding experience. The SDK offers the following key capabilities:

The SDK supports event callbacks based on long connections. For more information, see Configure event subscription method and Receive callbacks through persistent connection.

The SDK provides structured API request parameters. For instance, for the Send Message API, the SDK offers structured encapsulation for various types of messages.

The SDK offers a complete lifecycle management for application access tokens (tenant_access_token), eliminating the need for developers to obtain and refresh application access tokens themselves.

The SDK provides straightforward documentation. Referencing the SDK documentation will help you understand how to install the SDK, how to call server-side APIs through the SDK, handle subscribed events and callbacks. For more details, see Server-side SDK.

IX. Technical Support

Getting technical support: Click the Technical Support link in the lower right corner of any page on the official website to get assistance with development issues. The support staff will help you resolve problems one-on-one.

Document feedback: If you discover errors in the development documentation during your development process, you can directly highlight and provide feedback on the document page. Your feedback will be sent to the documentation team and will be promptly addressed if valid.

SDK discussion groups: If you encounter problems while using the SDK, you can join the following SDK discussion groups. For nodeJS SDK issues, you can submit issues directly.

Java SDK Discussion Group
Python SDK Discussion Group
Go SDK Discussion Group
Click here or scan the QR code to join the SDK discussion group.
Click here or scan the QR code to join the SDK discussion group.
Click here or scan the QR code to join the SDK discussion group.

Join the Developer Community: If you want to get early access to the latest capabilities and communicate with other developers, feel free to join the Feishu Developer Community.

Development mode	Low-Code development	Low-Code development	Zero code development	Build AI Agents
Platform capabilities	Feishu Integration Platform (AnyCross) provides organizations with standard and efficient system integration capabilities, allowing them to create powerful integration solutions and realize comprehensive data communication across their business systems. This makes integration more standardized, secure, and simple.	Feishu Low-Code Platform (aPaaS) offers organizations full-code underlying capabilities and a low-code development experience. It empowers every developer to become a full-stack engineer, enabling the delivery of complex business systems with greater agility and user-friendliness.	Feishu Base provides capabilities such as views, dashboards, forms, automation, and plugins to customize exclusive business systems.	Feishu Aily focuses on large language models (LLM) to offer AI skill orchestration, knowledge data processing, effect optimization, and continuous operation capabilities. This enables users to efficiently develop professional organization-level intelligent applications and publish them in Feishu, Web, and other channels with a single click.
Illustration

Feature	Bot	Web app (H5)	Add-on
Scenario	A Bot is an application that interacts with users through conversations. By integrating Feishu Calendar, Approval, documents, and third-party business systems, Feishu can aggregate notifications from various applications (such as monitoring alerts, task reminders, and data reports) in one place. It also supports automated group management, monitoring, and responding to user messages. For more details, see Bot overview.	A web app is an application developed using H5, which can run within the Feishu client. By leveraging Feishu's open APIs (such as identity authentication, contacts, and Docs), organizations can deeply integrate existing applications with Feishu's ecosystem and quickly migrate applications using the SSO single sign-on system. For more details, see Web app overview.	An add-on is a unique and lightweight functional block developed by Feishu, serving as an information unit carrier that combines rendering, interaction, and data. It ensures smooth information flow and consumption within the Feishu suite. Through add-ons, IT and third-party service providers can develop applications for various scenarios, enabling document collaboration and organization workflow integration, thereby enhancing the capabilities of the Feishu suite and improving efficiency. For more details, see Docs add-on overview and Base extensions overview.

Scenario	Description	API and reference examples
Automated weekly/monthly reports	Automated weekly and daily reports can standardize report formats, automate reminders and notifications, improve report quality and timeliness, and save manpower. By using Feishu's Docs capabilities, teams can: Create a new weekly report from a template and grant team members editing permissions Automatically archive the weekly report to a specified node in the wiki Send group messages through group chat bots to notify everyone to update the current week's report content	Docs API Get Root Folder Meta Get Folder Children Obtain Metadata Copy a Doc or Sheet Add permissions Add Wiki space members Move cloud document to Wiki Message and group API: Obtain groups where the user or bot is a member Send message Tutorials: Manage Weekly Report with Docs
Sales statistics using spreadsheets	Using the open capabilities of Feishu Sheets, external sales data can be synchronized into the spreadsheet for total calculation: Create a spreadsheet through API Write external data, add SUM formulas, and set styles Set document permissions for specified users	Docs API: Get Root Folder Meta Create a spreadsheet Obtain Spreadsheet Metadata Write data to multiple ranges Batch Set Cell Style Add permissions Tutorials: Track Sales Statistics with Spreadsheets
Daily to-do reminders from Wiki reports	Extract to-do items (tasks, assignees, and deadlines) from the latest weekly report and send automated reminders through a group chat.	Login API: Get custom app tenant_access_token Docs API: Get the list of child nodes in Wiki Get Wiki node information Get Document Message and group API: Obtain groups where the user or bot is a member Send message
Agile project management with Base	Use Base for agile project management and create a public calendar for project iteration cycles, which is available for subscription by the entire team.	Login API: Get custom app tenant_access_token Docs API: List records Update records Create records Create table List fields Create field Update field Calendar API: Create a shared calendar Send message Tutorials: Manage Agile Project with Base
Replace links after document migration	In data migration, you can import local files into Feishu Docs, identify outdated links, and correct them with new links after the import.	Login API: Get custom app tenant_access_token Docs API: Get Root Folder Meta Upload a file Create an import task Query import task result Update document sharing settings Obtain all blocks of a document Update a block Tutorials: Replace Links after Doc migration

Scenario	Business pain points	Solution
Financial approval management	Every day, you have a large number of processes that require your approval. It is not difficult to find the documents and click approve in the business system, but the challenge lies in the disconnection between process approval and corresponding execution. Your day is consumed in the endless cycle of confirming applicants, validating the rationale for applications, manually executing operations in various systems, and providing feedback to applicants.	How POIZON uses Feishu's open capabilities to achieve intelligent approval management
Sales knowledge collaboration	Your daily work involves supporting store sales, deliveries, and after-sales service needs. During customer service, you often need to look up professional terms and the latest policy knowledge. For customized customer needs and complex issues, you sometimes need to connect with expert support. How can you quickly access the latest and most comprehensive knowledge and connect with the most relevant experts for timely support?	Automation solution in Li Auto Inc.
Enterprise business operations	You are responsible for store operations, supply chain, and marketing activity management, often needing to query and analyze data. When on the go, accessing business systems via a mobile phone is extremely difficult, let alone hoping to obtain data in real-time and capture abnormal data as early as possible.	How AUNTEA JENNY leverages robots to make business data readily available

Call a server API (Send message)	Call a server API (Create Base app)	Develop an echo bot
Develop a card interactive bot	Embed a web app into Feishu Workplace	Develop H5 (Node.js)

Java SDK Discussion Group	Python SDK Discussion Group	Go SDK Discussion Group
Click here or scan the QR code to join the SDK discussion group.	Click here or scan the QR code to join the SDK discussion group.	Click here or scan the QR code to join the SDK discussion group.