Feishu
This page contains the setup guide and reference information for the Feishu (also known as Lark) source connector.
The Feishu source connector syncs records from a Feishu/Lark Bitable (Base) table using the Feishu Open Platform API.
Prerequisites
- A Feishu or Lark account
- A custom app created in the Feishu Open Platform (or Lark Developer) with Bitable read permissions
- The App ID and App Secret for that custom app
- A Bitable (Base) with at least one table you want to sync
Setup guide
Step 1: Create a custom app in the Feishu Open Platform
- Go to the Feishu Open Platform Developer Console (or Lark Developer Console for international accounts).
- Click Create Custom App and fill in the app name and description.
- After creation, navigate to Credentials & Basic Info to find your App ID and App Secret.
Step 2: Grant Bitable permissions
- In your custom app's settings, go to Permissions & Scopes.
- Add the Bitable-related scopes required for reading records (for example,
bitable:app:readonlyorbitable:app). - Publish the app or submit it for review, depending on your organization's requirements.
Step 3: Find your Bitable App Token and Table ID
- Open the Bitable (Base) you want to sync in your browser.
- The App Token is in the URL path:
https://your-domain.feishu.cn/base/{app_token}. - The Table ID is in the URL query parameter:
?table={table_id}.
Step 4: Set up the connector in Airbyte
- In Airbyte, go to Sources and select Feishu.
- Enter the App ID and App Secret from Step 1.
- Enter the App Token and Table ID from Step 3.
- If you use Lark (international), change the Lark Host to
https://open.larksuite.com. The default (https://open.feishu.cn) is for Feishu (China mainland). - Optionally adjust the Page Size (default: 100, maximum: 500).
- Click Set up source.
Supported sync modes
The Feishu source connector supports the following sync modes:
Supported streams
| Stream | Primary key | Pagination | Incremental |
|---|---|---|---|
| records | record_id | Cursor-based (page_token) | No |
The records stream returns all records from the specified Bitable table. Each record includes a record_id, an optional id, and a fields object containing the values for each column in the table. The structure of the fields object depends on the columns defined in your Bitable table.
Limitations
- This connector syncs records from a single Bitable table per configured source. To sync multiple tables, create a separate source for each.
- Only full refresh sync is supported. Incremental sync is not available.
Reference
Config fields reference
Field
Type
Property name
string
app_id
string
app_secret
string
app_token
string
lark_host
string
table_id
number
page_size