Skip to main content

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

  1. Go to the Feishu Open Platform Developer Console (or Lark Developer Console for international accounts).
  2. Click Create Custom App and fill in the app name and description.
  3. After creation, navigate to Credentials & Basic Info to find your App ID and App Secret.

Step 2: Grant Bitable permissions

  1. In your custom app's settings, go to Permissions & Scopes.
  2. Add the Bitable-related scopes required for reading records (for example, bitable:app:readonly or bitable:app).
  3. Publish the app or submit it for review, depending on your organization's requirements.

Step 3: Find your Bitable App Token and Table ID

  1. Open the Bitable (Base) you want to sync in your browser.
  2. The App Token is in the URL path: https://your-domain.feishu.cn/base/{app_token}.
  3. The Table ID is in the URL query parameter: ?table={table_id}.

Step 4: Set up the connector in Airbyte

  1. In Airbyte, go to Sources and select Feishu.
  2. Enter the App ID and App Secret from Step 1.
  3. Enter the App Token and Table ID from Step 3.
  4. 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).
  5. Optionally adjust the Page Size (default: 100, maximum: 500).
  6. Click Set up source.

Supported sync modes

The Feishu source connector supports the following sync modes:

Supported streams

StreamPrimary keyPaginationIncremental
recordsrecord_idCursor-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

Changelog

Expand to review
VersionDatePull RequestSubject
0.0.22026-02-2473777Update dependencies
0.0.12026-02-1971256Initial release by @WYW-min via Connector Builder