Feishu / Lark

API keyCommunication & SupportOrg connection

Org-level connection

Feishu / Lark is connected once at the org level by an admin. The credential is shared across all groups that have been granted access — individual team members don't need to connect their own accounts.

Getting your API key

Create a self-built app in your Feishu (open.feishu.cn) or Lark (open.larksuite.com) developer console.

Under Permissions & Scopes, enable the scopes you need (im, contact, docx, sheets, bitable, calendar, approval) and publish an app version for them to take effect.

Copy the app's App ID and App Secret.

Paste them below as "App ID|App Secret" (App ID, a pipe, then App Secret).

Set Region: enter "feishu" for the China platform (open.feishu.cn) or "lark" for international (open.larksuite.com). Defaults to lark.

Ready to connect?

Permissions (scopes)

These are the data scopes On Belay can be granted for Feishu / Lark. Your org admin controls which scopes are enabled per group.

Scope	Description	Access
`im:read`	Read messages and chats	Read only
`im:write`	Send messages	Read / Write
`contact:read`	Read users and departments	Read only
`docs:read`	Read Drive files and documents	Read only
`sheets:read`	Read spreadsheets	Read only
`bitable:read`	Read Base tables and records	Read only
`bitable:write`	Create Base records	Read / Write
`calendar:read`	Read calendars and events	Read only
`calendar:write`	Create calendar events	Read / Write
`approval:read`	Read approval instances	Read only
`approval:write`	Create approval instances	Read / Write

Troubleshooting

"Invalid API key" or "Unauthorized" error

Double-check that you copied the full key without any leading/trailing spaces. Some platforms show a truncated preview — make sure to copy the full token. If the key was generated with restricted scopes, verify it includes the permissions listed above.

Connected but Claude can't access data

Check that your group has been granted access to this integration in On Belay → Groups → [your group] → Integrations. Also verify the specific scopes your group is permitted to use match what your query requires.

The key expires or stops working

Some API keys have expiration policies. Generate a new key in Feishu / Lark and update it in On Belay → Integrations → Feishu / Lark → Update key. Consider creating a dedicated service account or machine user for On Belay so the key isn't tied to a personal account.

Still stuck? We're happy to help.

Contact support →