@danyow/lark-mcp 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +62 -0
- package/LICENSE +9 -0
- package/README.md +215 -0
- package/README_ZH.md +212 -0
- package/dist/auth/config.d.ts +12 -0
- package/dist/auth/config.js +15 -0
- package/dist/auth/handler/handler-local.d.ts +21 -0
- package/dist/auth/handler/handler-local.js +123 -0
- package/dist/auth/handler/handler.d.ts +32 -0
- package/dist/auth/handler/handler.js +117 -0
- package/dist/auth/handler/index.d.ts +2 -0
- package/dist/auth/handler/index.js +18 -0
- package/dist/auth/index.d.ts +4 -0
- package/dist/auth/index.js +20 -0
- package/dist/auth/provider/index.d.ts +3 -0
- package/dist/auth/provider/index.js +19 -0
- package/dist/auth/provider/oauth.d.ts +18 -0
- package/dist/auth/provider/oauth.js +147 -0
- package/dist/auth/provider/oidc.d.ts +18 -0
- package/dist/auth/provider/oidc.js +172 -0
- package/dist/auth/provider/types.d.ts +8 -0
- package/dist/auth/provider/types.js +2 -0
- package/dist/auth/store.d.ts +39 -0
- package/dist/auth/store.js +213 -0
- package/dist/auth/types.d.ts +13 -0
- package/dist/auth/types.js +2 -0
- package/dist/auth/utils/encryption.d.ts +7 -0
- package/dist/auth/utils/encryption.js +40 -0
- package/dist/auth/utils/index.d.ts +3 -0
- package/dist/auth/utils/index.js +19 -0
- package/dist/auth/utils/is-token-valid.d.ts +7 -0
- package/dist/auth/utils/is-token-valid.js +28 -0
- package/dist/auth/utils/pkce.d.ts +6 -0
- package/dist/auth/utils/pkce.js +20 -0
- package/dist/auth/utils/storage-manager.d.ts +17 -0
- package/dist/auth/utils/storage-manager.js +135 -0
- package/dist/cli/index.d.ts +1 -0
- package/dist/cli/index.js +5 -0
- package/dist/cli/login-handler.d.ts +16 -0
- package/dist/cli/login-handler.js +142 -0
- package/dist/cli.d.ts +4 -0
- package/dist/cli.js +122 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +19 -0
- package/dist/mcp-server/index.d.ts +2 -0
- package/dist/mcp-server/index.js +18 -0
- package/dist/mcp-server/shared/index.d.ts +2 -0
- package/dist/mcp-server/shared/index.js +18 -0
- package/dist/mcp-server/shared/init.d.ts +10 -0
- package/dist/mcp-server/shared/init.js +121 -0
- package/dist/mcp-server/shared/types.d.ts +40 -0
- package/dist/mcp-server/shared/types.js +10 -0
- package/dist/mcp-server/transport/index.d.ts +3 -0
- package/dist/mcp-server/transport/index.js +19 -0
- package/dist/mcp-server/transport/sse.d.ts +2 -0
- package/dist/mcp-server/transport/sse.js +75 -0
- package/dist/mcp-server/transport/stdio.d.ts +2 -0
- package/dist/mcp-server/transport/stdio.js +36 -0
- package/dist/mcp-server/transport/streamable.d.ts +2 -0
- package/dist/mcp-server/transport/streamable.js +86 -0
- package/dist/mcp-server/transport/utils.d.ts +16 -0
- package/dist/mcp-server/transport/utils.js +34 -0
- package/dist/mcp-tool/constants.d.ts +49 -0
- package/dist/mcp-tool/constants.js +115 -0
- package/dist/mcp-tool/document-tool/index.d.ts +1 -0
- package/dist/mcp-tool/document-tool/index.js +17 -0
- package/dist/mcp-tool/document-tool/recall/index.d.ts +2 -0
- package/dist/mcp-tool/document-tool/recall/index.js +39 -0
- package/dist/mcp-tool/document-tool/recall/request.d.ts +2 -0
- package/dist/mcp-tool/document-tool/recall/request.js +25 -0
- package/dist/mcp-tool/document-tool/recall/type.d.ts +19 -0
- package/dist/mcp-tool/document-tool/recall/type.js +2 -0
- package/dist/mcp-tool/index.d.ts +5 -0
- package/dist/mcp-tool/index.js +21 -0
- package/dist/mcp-tool/mcp-tool.d.ts +52 -0
- package/dist/mcp-tool/mcp-tool.js +198 -0
- package/dist/mcp-tool/tools/en/builtin-tools/docx/builtin.d.ts +5 -0
- package/dist/mcp-tool/tools/en/builtin-tools/docx/builtin.js +219 -0
- package/dist/mcp-tool/tools/en/builtin-tools/drive/builtin.d.ts +4 -0
- package/dist/mcp-tool/tools/en/builtin-tools/drive/builtin.js +159 -0
- package/dist/mcp-tool/tools/en/builtin-tools/im/buildin.d.ts +4 -0
- package/dist/mcp-tool/tools/en/builtin-tools/im/buildin.js +63 -0
- package/dist/mcp-tool/tools/en/builtin-tools/index.d.ts +5 -0
- package/dist/mcp-tool/tools/en/builtin-tools/index.js +7 -0
- package/dist/mcp-tool/tools/en/gen-tools/index.d.ts +114 -0
- package/dist/mcp-tool/tools/en/gen-tools/index.js +129 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/acs_v1.d.ts +562 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/acs_v1.js +264 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/admin_v1.d.ts +912 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/admin_v1.js +449 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/aily_v1.d.ts +1213 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/aily_v1.js +560 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/apaas_v1.d.ts +2530 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/apaas_v1.js +949 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v5.d.ts +80 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v5.js +53 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v6.d.ts +1008 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v6.js +775 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/approval_v4.d.ts +3928 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/approval_v4.js +1602 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/attendance_v1.d.ts +6043 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/attendance_v1.js +1857 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/auth_v3.d.ts +151 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/auth_v3.js +71 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/authen_v1.d.ts +26 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/authen_v1.js +17 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/baike_v1.d.ts +2174 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/baike_v1.js +594 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/base_v2.d.ts +755 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/base_v2.js +234 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/bitable_v1.d.ts +3541 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/bitable_v1.js +1786 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/board_v1.d.ts +40 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/board_v1.js +18 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/calendar_v4.d.ts +2075 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/calendar_v4.js +1594 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/cardkit_v1.d.ts +528 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/cardkit_v1.js +260 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/compensation_v1.d.ts +189 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/compensation_v1.js +132 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/contact_v3.d.ts +4274 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/contact_v3.js +2583 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v1.d.ts +16873 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v1.js +5045 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v2.d.ts +29387 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v2.js +7787 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/directory_v1.d.ts +4274 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/directory_v1.js +1367 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docs_v1.d.ts +58 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docs_v1.js +28 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docx_v1.d.ts +93466 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docx_v1.js +14350 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v1.d.ts +3251 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v1.js +1422 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v2.d.ts +174 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v2.js +117 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/ehr_v1.d.ts +86 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/ehr_v1.js +48 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/event_v1.d.ts +44 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/event_v1.js +17 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/helpdesk_v1.d.ts +733 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/helpdesk_v1.js +285 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v1.d.ts +10076 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v1.js +6065 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v2.d.ts +158 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v2.js +61 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/human_authentication_v1.d.ts +70 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/human_authentication_v1.js +27 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v1.d.ts +3043 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v1.js +1869 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v2.d.ts +2176 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v2.js +460 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/lingo_v1.d.ts +2301 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/lingo_v1.js +669 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mail_v1.d.ts +2462 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mail_v1.js +1655 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v1.d.ts +104 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v1.js +45 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v3.d.ts +329 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v3.js +78 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/minutes_v1.d.ts +92 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/minutes_v1.js +62 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/moments_v1.d.ts +52 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/moments_v1.js +24 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/okr_v1.d.ts +1628 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/okr_v1.js +434 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/optical_char_recognition_v1.d.ts +38 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/optical_char_recognition_v1.js +17 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/passport_v1.d.ts +131 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/passport_v1.js +59 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/payroll_v1.d.ts +333 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/payroll_v1.js +176 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v1.d.ts +309 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v1.js +178 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v2.d.ts +1177 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v2.js +559 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/personal_settings_v1.d.ts +640 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/personal_settings_v1.js +303 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/report_v1.d.ts +192 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/report_v1.js +71 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/search_v2.d.ts +1695 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/search_v2.js +446 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/security_and_compliance_v1.d.ts +68 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/security_and_compliance_v1.js +32 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v2.d.ts +523 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v2.js +231 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v3.d.ts +979 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v3.js +721 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/speech_to_text_v1.d.ts +225 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/speech_to_text_v1.js +65 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v1.d.ts +1161 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v1.js +672 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v2.d.ts +6051 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v2.js +1970 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/tenant_v2.d.ts +31 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/tenant_v2.js +24 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/translation_v1.d.ts +80 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/translation_v1.js +37 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/trust_party_v1.d.ts +182 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/trust_party_v1.js +141 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/vc_v1.d.ts +5725 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/vc_v1.js +1751 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/verification_v1.d.ts +21 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/verification_v1.js +14 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v1.d.ts +72 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v1.js +19 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v2.d.ts +843 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v2.js +381 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/workplace_v1.d.ts +116 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/workplace_v1.js +77 -0
- package/dist/mcp-tool/tools/index.d.ts +104 -0
- package/dist/mcp-tool/tools/index.js +9 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/docx/builtin.d.ts +5 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/docx/builtin.js +198 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/drive/builtin.d.ts +4 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/drive/builtin.js +159 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/im/buildin.d.ts +4 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/im/buildin.js +63 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/index.d.ts +5 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/index.js +7 -0
- package/dist/mcp-tool/tools/zh/gen-tools/index.d.ts +114 -0
- package/dist/mcp-tool/tools/zh/gen-tools/index.js +129 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/acs_v1.d.ts +562 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/acs_v1.js +277 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/admin_v1.d.ts +912 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/admin_v1.js +430 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/aily_v1.d.ts +1213 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/aily_v1.js +541 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/apaas_v1.d.ts +2530 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/apaas_v1.js +885 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v5.d.ts +80 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v5.js +59 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v6.d.ts +1007 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v6.js +721 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/approval_v4.d.ts +3928 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/approval_v4.js +1532 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/attendance_v1.d.ts +6043 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/attendance_v1.js +1620 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/auth_v3.d.ts +151 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/auth_v3.js +87 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/authen_v1.d.ts +26 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/authen_v1.js +17 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/baike_v1.d.ts +2174 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/baike_v1.js +574 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/base_v2.d.ts +755 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/base_v2.js +270 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/bitable_v1.d.ts +3541 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/bitable_v1.js +1864 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/board_v1.d.ts +40 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/board_v1.js +18 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/calendar_v4.d.ts +2075 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/calendar_v4.js +1533 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/cardkit_v1.d.ts +528 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/cardkit_v1.js +248 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/compensation_v1.d.ts +189 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/compensation_v1.js +130 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/contact_v3.d.ts +4274 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/contact_v3.js +2394 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v1.d.ts +16957 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v1.js +4753 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v2.d.ts +29869 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v2.js +7902 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/directory_v1.d.ts +4324 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/directory_v1.js +1340 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docs_v1.d.ts +58 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docs_v1.js +26 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docx_v1.d.ts +116719 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docx_v1.js +14949 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v1.d.ts +3251 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v1.js +1395 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v2.d.ts +174 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v2.js +115 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/ehr_v1.d.ts +86 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/ehr_v1.js +48 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/event_v1.d.ts +44 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/event_v1.js +25 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/helpdesk_v1.d.ts +733 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/helpdesk_v1.js +279 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v1.d.ts +10085 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v1.js +5787 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v2.d.ts +158 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v2.js +64 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/human_authentication_v1.d.ts +70 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/human_authentication_v1.js +27 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v1.d.ts +3043 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v1.js +1812 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v2.d.ts +2176 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v2.js +454 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/lingo_v1.d.ts +2301 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/lingo_v1.js +650 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mail_v1.d.ts +2465 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mail_v1.js +1467 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v1.d.ts +104 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v1.js +45 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v3.d.ts +329 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v3.js +76 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/minutes_v1.d.ts +92 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/minutes_v1.js +62 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/moments_v1.d.ts +52 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/moments_v1.js +20 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/okr_v1.d.ts +1664 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/okr_v1.js +455 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/optical_char_recognition_v1.d.ts +38 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/optical_char_recognition_v1.js +17 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/passport_v1.d.ts +131 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/passport_v1.js +53 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/payroll_v1.d.ts +609 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/payroll_v1.js +321 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v1.d.ts +309 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v1.js +165 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v2.d.ts +1177 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v2.js +525 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/personal_settings_v1.d.ts +640 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/personal_settings_v1.js +295 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/report_v1.d.ts +194 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/report_v1.js +72 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/search_v2.d.ts +1695 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/search_v2.js +556 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/security_and_compliance_v1.d.ts +68 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/security_and_compliance_v1.js +32 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v2.d.ts +523 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v2.js +231 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v3.d.ts +979 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v3.js +821 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/speech_to_text_v1.d.ts +225 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/speech_to_text_v1.js +65 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v1.d.ts +1161 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v1.js +647 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v2.d.ts +6077 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v2.js +1894 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/tenant_v2.d.ts +31 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/tenant_v2.js +24 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/translation_v1.d.ts +80 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/translation_v1.js +37 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/trust_party_v1.d.ts +182 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/trust_party_v1.js +137 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/vc_v1.d.ts +5725 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/vc_v1.js +1640 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/verification_v1.d.ts +21 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/verification_v1.js +14 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v1.d.ts +72 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v1.js +34 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v2.d.ts +843 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v2.js +376 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/workplace_v1.d.ts +116 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/workplace_v1.js +77 -0
- package/dist/mcp-tool/types/index.d.ts +53 -0
- package/dist/mcp-tool/types/index.js +9 -0
- package/dist/mcp-tool/utils/case-transf.d.ts +2 -0
- package/dist/mcp-tool/utils/case-transf.js +15 -0
- package/dist/mcp-tool/utils/filter-tools.d.ts +2 -0
- package/dist/mcp-tool/utils/filter-tools.js +27 -0
- package/dist/mcp-tool/utils/get-should-use-uat.d.ts +2 -0
- package/dist/mcp-tool/utils/get-should-use-uat.js +18 -0
- package/dist/mcp-tool/utils/handler.d.ts +2 -0
- package/dist/mcp-tool/utils/handler.js +119 -0
- package/dist/mcp-tool/utils/index.d.ts +4 -0
- package/dist/mcp-tool/utils/index.js +20 -0
- package/dist/utils/clean-env-args.d.ts +1 -0
- package/dist/utils/clean-env-args.js +12 -0
- package/dist/utils/constants.d.ts +18 -0
- package/dist/utils/constants.js +35 -0
- package/dist/utils/http-instance.d.ts +2 -0
- package/dist/utils/http-instance.js +21 -0
- package/dist/utils/logger.d.ts +22 -0
- package/dist/utils/logger.js +97 -0
- package/dist/utils/noop.d.ts +1 -0
- package/dist/utils/noop.js +6 -0
- package/dist/utils/parser-string-array.d.ts +1 -0
- package/dist/utils/parser-string-array.js +13 -0
- package/dist/utils/safe-json-parse.d.ts +1 -0
- package/dist/utils/safe-json-parse.js +14 -0
- package/dist/utils/version.d.ts +1 -0
- package/dist/utils/version.js +52 -0
- package/docs/recall-mcp/README.md +137 -0
- package/docs/recall-mcp/README_ZH.md +137 -0
- package/docs/reference/cli/cli-zh.md +92 -0
- package/docs/reference/cli/cli.md +92 -0
- package/docs/reference/tool-presets/presets-zh.md +120 -0
- package/docs/reference/tool-presets/presets.md +120 -0
- package/docs/reference/tool-presets/tools-en.md +1527 -0
- package/docs/reference/tool-presets/tools-zh.md +1544 -0
- package/docs/troubleshooting/faq-zh.md +67 -0
- package/docs/troubleshooting/faq.md +67 -0
- package/docs/usage/configuration/configuration-zh.md +344 -0
- package/docs/usage/configuration/configuration.md +344 -0
- package/docs/usage/docker/docker-zh.md +101 -0
- package/docs/usage/docker/docker.md +106 -0
- package/package.json +65 -0
|
@@ -0,0 +1,1527 @@
|
|
|
1
|
+
# Lark MCP Tools List
|
|
2
|
+
## Business domain: acsV1
|
|
3
|
+
| MCP Tool Name | API | Description |
|
|
4
|
+
| --- | --- | --- |
|
|
5
|
+
| acs.v1.accessRecord.list | [Get access record list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list) | Smart Access Control-Access Record-Get access record list |
|
|
6
|
+
| acs.v1.device.list | [Get device list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list) | Smart Access Control-Device-Get device list |
|
|
7
|
+
| acs.v1.ruleExternal.create | [Create or update rule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create) | rule create or update rule |
|
|
8
|
+
| acs.v1.ruleExternal.delete | [Delete rule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete) | rule delete |
|
|
9
|
+
| acs.v1.ruleExternal.deviceBind | [Device bind rule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind) | device bind rules |
|
|
10
|
+
| acs.v1.ruleExternal.get | [Get rule info](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get) | rule info get |
|
|
11
|
+
| acs.v1.user.get | [Get individual user information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get) | Smart Access Control-User Management-Get individual user information |
|
|
12
|
+
| acs.v1.user.list | [Get user list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list) | Smart Access Control-User Management-Get user list |
|
|
13
|
+
| acs.v1.user.patch | [Modify parts of user information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch) | Smart Access Control-User Management-Modify parts of user information |
|
|
14
|
+
| acs.v1.visitor.create | [Add visitor](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create) | visitor add |
|
|
15
|
+
| acs.v1.visitor.delete | [Delete visitor](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete) | visitor delete |
|
|
16
|
+
|
|
17
|
+
## Business domain: adminV1
|
|
18
|
+
| MCP Tool Name | API | Description |
|
|
19
|
+
| --- | --- | --- |
|
|
20
|
+
| admin.v1.adminDeptStat.list | [Obtain active users and function usage data in the department dimension](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list) | The API is used to obtain active users and function usage data in the department dimension, including the usage data about IM (Instant Messaging), Calendar, Docs, Audio/Video and Email Conferencing |
|
|
21
|
+
| admin.v1.adminUserStat.list | [Obtain active users and function usage data in the user dimension](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list) | This API is used to obtain active users and function usage data in the user dimension. That is, the usage data of IM (Instant messaging), Calendar, Docs, Audio/Video conferencing and Email functions |
|
|
22
|
+
| admin.v1.auditInfo.list | [Get behavior audit log](https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get) | security_and_compliance-Behavior audit log-Get behavior audit log |
|
|
23
|
+
| admin.v1.badge.create | [Create a badge](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create) | Use this API to create a complete badge information, up to 1000 badges can be created under a tenant |
|
|
24
|
+
| admin.v1.badge.get | [Get the badge detail](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get) | You can query the detail of the badge through this API |
|
|
25
|
+
| admin.v1.badgeGrant.create | [Create a grant list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/create) | Through this API, a list of grants can be created for a specific badge, and up to 1,000 grant lists can be created under one badge |
|
|
26
|
+
| admin.v1.badgeGrant.delete | [Delete the grant list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/delete) | This API allows you to delete information for a specific grant |
|
|
27
|
+
| admin.v1.badgeGrant.get | [Get the grant list detail](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get) | Information on specific grant can be obtained through this API |
|
|
28
|
+
| admin.v1.badgeGrant.list | [List of grants to receive badge](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list) | Through this API, you can obtain a list of grant lists under a specific badge, and the order of the grant lists is displayed in descending order according to the creation time |
|
|
29
|
+
| admin.v1.badgeGrant.update | [Modify the grant list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/update) | Through this API, information about a specific grant list can be modified |
|
|
30
|
+
| admin.v1.badge.list | [Get a list of badges](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list) | All the badges under the tenant can be listed through this API, and the order of the badges is displayed in descending order according to the creation time |
|
|
31
|
+
| admin.v1.badge.update | [Modify the badge information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/update) | Through this API, the information of the badge can be modified |
|
|
32
|
+
| admin.v1.password.reset | [Reset user enterprise email password](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/password/reset) | Admin-Login password management-Reset user enterprise email password |
|
|
33
|
+
|
|
34
|
+
## Business domain: ailyV1
|
|
35
|
+
| MCP Tool Name | API | Description |
|
|
36
|
+
| --- | --- | --- |
|
|
37
|
+
| aily.v1.ailySessionAilyMessage.create | [Send aily message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create) | The API is used to send a message to a Feishu smart partner application; each message belongs to an active session |
|
|
38
|
+
| aily.v1.ailySessionAilyMessage.get | [Get aily message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get) | This API is used to obtain the detailed information of the message of a Feishu smart partner application; including the content of the message, the sender, and so on |
|
|
39
|
+
| aily.v1.ailySessionAilyMessage.list | [List aily messages](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list) | This API is used to list the details of the message under a session of a Feishu smart partner application; including the content of the message, the sender, etc |
|
|
40
|
+
| aily.v1.ailySession.create | [Create session](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/create) | This API is used to create a session with a Feishu smart partner application; when the session is created successfully, you can send messages, create and run |
|
|
41
|
+
| aily.v1.ailySession.delete | [Delete session](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/delete) | This API is used to delete a session with a Feishu Smart Partner application |
|
|
42
|
+
| aily.v1.ailySession.get | [Get session](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/get) | This API is used to obtain detailed information about a session with a Feishu smart partner application, including the state of the session, channel context, creation time, and so on |
|
|
43
|
+
| aily.v1.ailySessionRun.cancel | [Cancel run](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/cancel) | This API is used to cancel the run of a Feishu Aily application |
|
|
44
|
+
| aily.v1.ailySessionRun.create | [Create run](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/create) | This API is used to create a Run on a session of a Feishu Aily application |
|
|
45
|
+
| aily.v1.ailySessionRun.get | [Get run](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/get) | This API is used to obtain detailed information about the Run of a Feishu Aily application, including the status of the run, the end time, and so on |
|
|
46
|
+
| aily.v1.ailySessionRun.list | [List runs](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-run/list) | This API is used to list the running details of a Feishu Aily application; including status, end time, and so on |
|
|
47
|
+
| aily.v1.ailySession.update | [Update session](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session/update) | This API is used to update information about a session with a Feishu Smart Partner application |
|
|
48
|
+
| aily.v1.appDataAssetTag.list | [List Data Knowledge Tag](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset_tag/list) | List Aily's data knowledge tags |
|
|
49
|
+
| aily.v1.appDataAsset.create | [Create data knowledge](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/create) | Add individual data knowledge in Aily |
|
|
50
|
+
| aily.v1.appDataAsset.delete | [Delete data knowledge](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/delete) | Delete Aily's data knowledge |
|
|
51
|
+
| aily.v1.appDataAsset.get | [Get individual data knowledge](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/get) | Get individual data knowledge |
|
|
52
|
+
| aily.v1.appDataAsset.list | [List Data Knowledges](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-data_asset/list) | Get the data knowledge list of the Aily |
|
|
53
|
+
| aily.v1.appSkill.get | [Get Skill](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/get) | This API is used to query the specific skill details of an Aily application |
|
|
54
|
+
| aily.v1.appSkill.list | [List Skill](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/list) | This API is used to query the skill list of an Aily application |
|
|
55
|
+
| aily.v1.appSkill.start | [Start Skill](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/app-skill/start) | The API is used to invoke a specific skill of an Aily application, supports specifying skill imported parameters; and returns the result of skill execution synchronously |
|
|
56
|
+
|
|
57
|
+
## Business domain: apaasV1
|
|
58
|
+
| MCP Tool Name | API | Description |
|
|
59
|
+
| --- | --- | --- |
|
|
60
|
+
| apaas.v1.app.list | [Query application basic information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/app/list) | Query basic information of applications under a tenant, such as application name and application namespace |
|
|
61
|
+
| apaas.v1.applicationAuditLog.auditLogList | [Query audit log list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/audit_log_list) | Query the audit log list |
|
|
62
|
+
| apaas.v1.applicationAuditLog.dataChangeLogDetail | [Data Change Log Detail](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/data_change_log_detail) | Query data change log details by log ID |
|
|
63
|
+
| apaas.v1.applicationAuditLog.dataChangeLogsList | [Data Change Logs List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/data_change_logs_list) | Query the data changelog list based on search/filter criteria |
|
|
64
|
+
| apaas.v1.applicationAuditLog.get | [Query The Audit Log detail](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/get) | Query log details based on Log ID |
|
|
65
|
+
| apaas.v1.applicationEnvironmentVariable.get | [Query Environment Variable Details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/get) | Query details of a specified environment variable in an app built on Feishu aPaaS, including label, description, value, etc |
|
|
66
|
+
| apaas.v1.applicationEnvironmentVariable.query | [Query Environment Variables List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/query) | Query a list of environment variables in an app built on Feishu aPaaS |
|
|
67
|
+
| apaas.v1.applicationFlow.execute | [Execute flow](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-flow/execute) | Execute the corresponding flow |
|
|
68
|
+
| apaas.v1.applicationFunction.invoke | [Execution Function](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-function/invoke) | execute the custom functions in an app built on Feishu App Engine |
|
|
69
|
+
| apaas.v1.applicationObject.oqlQuery | [Execute OQL](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/oql_query) | Execute OQL statement in an app |
|
|
70
|
+
| apaas.v1.applicationObjectRecord.batchCreate | [Batch Create Records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_create) | Creates multiple records |
|
|
71
|
+
| apaas.v1.applicationObjectRecord.batchDelete | [Batch Delete Records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_delete) | Deletes multiple records |
|
|
72
|
+
| apaas.v1.applicationObjectRecord.batchQuery | [Query Record List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_query) | Get the record list that meets specified conditions |
|
|
73
|
+
| apaas.v1.applicationObjectRecord.batchUpdate | [Batch Update Records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_update) | Edits multiple records |
|
|
74
|
+
| apaas.v1.applicationObjectRecord.create | [Create Record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/create) | Creates record |
|
|
75
|
+
| apaas.v1.applicationObjectRecord.delete | [Delete Record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/delete) | Deletes specified record |
|
|
76
|
+
| apaas.v1.applicationObjectRecord.patch | [Edit Record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/patch) | Edits specified record |
|
|
77
|
+
| apaas.v1.applicationObjectRecord.query | [Get Record Details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/query) | Get specified record details |
|
|
78
|
+
| apaas.v1.applicationObject.search | [Search Record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/search) | Searches recourds in app |
|
|
79
|
+
| apaas.v1.applicationRecordPermissionMember.batchCreateAuthorization | [Batch Create Record Permission Member Authorizations](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_create_authorization) | Batch create record permission user authorizations |
|
|
80
|
+
| apaas.v1.applicationRecordPermissionMember.batchRemoveAuthorization | [Batch Delete Record Permission Member Authorizations](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_remove_authorization) | Feishu aPaaS-Permission-Record Permission-Batch Delete Record Permission Member Authorizations-Batch delete record permission user authorizations |
|
|
81
|
+
| apaas.v1.applicationRoleMember.batchCreateAuthorization | [Batch Create Role Member Authorizations](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_create_authorization) | Batch create role member authorizations |
|
|
82
|
+
| apaas.v1.applicationRoleMember.batchRemoveAuthorization | [Batch Delete Role Member Authorizations](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_remove_authorization) | Batch delete role member authorizations |
|
|
83
|
+
| apaas.v1.applicationRoleMember.get | [Query Role Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/get) | Query Role Member |
|
|
84
|
+
| apaas.v1.approvalInstance.cancel | [Cancel User Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_instance/cancel) | Cancel a human task (including approval tasks, fill in tasks) |
|
|
85
|
+
| apaas.v1.approvalTask.addAssignee | [Add approver for user task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/add_assignee) | Perform the action of adding approver for user task |
|
|
86
|
+
| apaas.v1.approvalTask.agree | [Approve user task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/agree) | Perform approval actions for user task |
|
|
87
|
+
| apaas.v1.approvalTask.reject | [Reject user task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/reject) | Perform rejection actions for user task |
|
|
88
|
+
| apaas.v1.approvalTask.transfer | [Transfer user task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/transfer) | Perform transfer actions for user task |
|
|
89
|
+
| apaas.v1.seatActivity.list | [Query Seat Activities Details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/seat_activity/list) | Gets the most recent active time for a user under a tenant to access an application using a per_user seat or a per_user_per_app seat. Feishu aPaaS system administrator is required to invoke the current API as an authorized person |
|
|
90
|
+
| apaas.v1.seatAssignment.list | [Query seat assignments details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/seat_assignment/list) | Get details about the assignments of per_user seats and per_user_per_app seats under the tenant, such as user ID, app namespace, etc. Feishu aPaaS system administrator is required to invoke the current API as an authorized person |
|
|
91
|
+
| apaas.v1.userTask.cc | [CC User Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/cc) | Make a CC of the current task |
|
|
92
|
+
| apaas.v1.userTask.chatGroup | [Chat User Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/chat_group) | Start a Feishu group chat based on the task |
|
|
93
|
+
| apaas.v1.userTask.expediting | [Expedition User Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/expediting) | Initiate a reminder for the current handler of the task |
|
|
94
|
+
| apaas.v1.userTask.query | [Query User Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/query) | Query the human task list |
|
|
95
|
+
| apaas.v1.userTask.rollback | [Rollback User Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback) | Return the current task once |
|
|
96
|
+
| apaas.v1.userTask.rollbackPoints | [Query User Task Rollback Point](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback_points) | Query the location where the current task can be returned |
|
|
97
|
+
|
|
98
|
+
## Business domain: applicationV5
|
|
99
|
+
| MCP Tool Name | API | Description |
|
|
100
|
+
| --- | --- | --- |
|
|
101
|
+
| application.v5.application.favourite | [获取用户常用的应用](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/favourite) | Workplace-My favorite-获取用户常用的应用 |
|
|
102
|
+
| application.v5.application.recommend | [获取企业推荐的应用](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v5/application/recommend) | Workplace-My favorite-获取企业推荐的应用 |
|
|
103
|
+
|
|
104
|
+
## Business domain: applicationV6
|
|
105
|
+
| MCP Tool Name | API | Description |
|
|
106
|
+
| --- | --- | --- |
|
|
107
|
+
| application.v6.appBadge.set | [Update app badge](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_badge/set) | Update app badge in workplace |
|
|
108
|
+
| application.v6.appRecommendRule.list | [Obtain the list of currently set recommend app rules](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list) | Workplace-My favorite-Obtain the list of currently set recommend app rules |
|
|
109
|
+
| application.v6.applicationAppUsage.departmentOverview | [Get an overview of multi-department application usage](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/department_overview) | Displays app usage data for a specific day, week, or month. You can filter data by sub-department level |
|
|
110
|
+
| application.v6.applicationAppUsage.messagePushOverview | [Get a message push overview](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/message_push_overview) | Displays bot message push data for a specific day, week, or month. You can filter data by department |
|
|
111
|
+
| application.v6.applicationAppUsage.overview | [Get App Usage Overview](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/overview) | Displays app usage data for a specific day, week, or month. You can view the app usage for the tenant or for a specific department |
|
|
112
|
+
| application.v6.applicationAppVersion.contactsRangeSuggest | [Get the Range of Contacts Data to Access in an App's Version Release Request](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/contacts_range_suggest) | This interface is used to obtain the permission scope of the contact of a certain version of the enterprise's self-built application according to the application's App ID and version ID |
|
|
113
|
+
| application.v6.applicationAppVersion.get | [Get App Version Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/get) | Obtains the version information of an app based on app_id and version_id |
|
|
114
|
+
| application.v6.applicationAppVersion.list | [Obtain App Version List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list) | Obtains the version list of an app based on app_id |
|
|
115
|
+
| application.v6.applicationAppVersion.patch | [Update version information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/patch) | Updates the app version review status |
|
|
116
|
+
| application.v6.applicationCollaborators.get | [Get a list of app collaborators](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-collaborators/get) | Get the collaborator information of the application (including the custom application and the store application) according to the app_id, including the owner, administrator, developer, operator of the application |
|
|
117
|
+
| application.v6.applicationCollaborators.update | [Update application collaborators](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-collaborators/update) | Add/remove an app collaborator from an app (including self-built apps and store apps), and the collaborator will receive an add notification after adding it |
|
|
118
|
+
| application.v6.application.contactsRangeConfiguration | [Get the Range of Contacts Data an App Can Access](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration) | Get the contacts permissions configuration that is actually effective online for a self-built application in the current enterprise |
|
|
119
|
+
| application.v6.applicationContactsRange.patch | [Update the contacts permission scope an app can access](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-contacts_range/patch) | Update the contacts permission scope of the custom app or store app in the enterprise, This API is only available to custom apps. The update takes effect immediately online |
|
|
120
|
+
| application.v6.applicationFeedback.list | [Get the app feedback list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/list) | Query application feedback data |
|
|
121
|
+
| application.v6.applicationFeedback.patch | [Update app feedback](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-feedback/patch) | Update application feedback data |
|
|
122
|
+
| application.v6.application.get | [Get Application Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/get) | Obtains basic information of an app based on the app_id |
|
|
123
|
+
| application.v6.application.list | [Obtain Applications Installed by an Organization](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/list) | This interface is used to query the list of applications installed by the company, and can only be called by the self-built applications |
|
|
124
|
+
| application.v6.applicationManagement.update | [Enable or disable application](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-management/update) | You can deactivate or enable self-built apps and store apps that have been installed in the enterprise |
|
|
125
|
+
| application.v6.applicationOwner.update | [Transfer application owner](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-owner/update) | Transfer the owner of a custom app to another person |
|
|
126
|
+
| application.v6.application.patch | [Update application information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/patch) | Updates app category information (Category changes can affect app sorting in Workplace, so proceed with caution) |
|
|
127
|
+
| application.v6.application.underauditlist | [Get Application Release Request List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/underauditlist) | Displays the list of all custom apps pending review for this company |
|
|
128
|
+
| application.v6.applicationVisibility.checkWhiteBlackList | [Obtain whether user in app visility white or black list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/check_white_black_list) | This api is used to query whether the user, department, or user group is in the white or black list of the application |
|
|
129
|
+
| application.v6.applicationVisibility.patch | [Update app availability](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-visibility/patch) | Call this interface to update the available scope of the specified application. It supports updating the available scope of the current enterprise-built application or the available scope of the installed store application, including available personnel and disabled personnel. After the available scope is updated, it will take effect online immediately |
|
|
130
|
+
| application.v6.scope.apply | [Apply for scopes from the admin](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/scope/apply) | Call this interface to apply to the tenant administrator for the API permissions that need to be reviewed within the application as an application |
|
|
131
|
+
| application.v6.scope.list | [Query tenant authorization status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/scope/list) | Call this interface to query the status of the current app applying for authorization from the tenant |
|
|
132
|
+
|
|
133
|
+
## Business domain: approvalV4
|
|
134
|
+
| MCP Tool Name | API | Description |
|
|
135
|
+
| --- | --- | --- |
|
|
136
|
+
| approval.v4.approval.create | [Create an approval definition](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create) | This interface is used to create an approval definition, allowing flexible specification of the basic information, forms, and processes of the approval definition |
|
|
137
|
+
| approval.v4.approval.get | [View approval definitions](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get) | Retrieve information about a specific approval definition based on filters such as approval definition code, language, user ID, etc. The information includes approval definition name, status, form controls, and nodes. After obtaining the approval definition information, you can construct a request to [create an approval instance] based on the information |
|
|
138
|
+
| approval.v4.approval.subscribe | [Subscribe to approval events](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe) | When the application [subscribes to approval events], it needs to call this interface to specify the approval definition Code (approval_code) to enable the subscription. Only after enabling it will the application be able to receive the events corresponding to that approval definition |
|
|
139
|
+
| approval.v4.approval.unsubscribe | [Unsubscribe from approval events](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/unsubscribe) | After unsubscribing approval_code, you can no longer receive event notifications for the corresponding instance of the review definition |
|
|
140
|
+
| approval.v4.externalApproval.create | [Create a third-party approval definition](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create) | The third-party approval definition is used to set the basic information of the approval, such as the name and description. At the same time, it is also necessary to set the approval initiation page, data callback URL and other information of the third-party approval system, so as to associate Feishu approval with the third-party approval system, so that enterprise employees can directly initiate the third-party approval within Feishu approval, and the approval center can send the approval data back to the third-party approval system |
|
|
141
|
+
| approval.v4.externalApproval.get | [View third-party approval definition](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/get) | Call this interface to obtain detailed information of the approval definition using the third-party approval definition code. This includes the name of the third-party approval definition, description, third-party approval initiation link, callback URL, and the list of visible personnel for the approval definition |
|
|
142
|
+
| approval.v4.externalInstance.check | [Verify instances](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/check) | Call this interface to verify third-party approval instance data, used to determine whether server-side data is up to date. Submit the latest update time of the instance when making the request. If the server does not have the instance or the instance update time on the server is not the latest, the corresponding instance ID will be returned.For example, set a timed task every 5 minutes to compare the instances generated in the past 5 minutes using this interface. If the data does not exist on the server or is not the latest, you can go to [synchronize third-party approval instance] based on the instance ID and task ID returned by this interface |
|
|
143
|
+
| approval.v4.externalInstance.create | [Sync instances](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create) | The Approval Center does not handle the circulation of approvals; the circulation of approvals occurs within the third-party system. This interface is used to synchronize the approval instances, approval tasks, and approval forwarding data generated in the third-party system after the approval circulation to the Approval Center |
|
|
144
|
+
| approval.v4.externalTask.list | [Status of third-party approval tasks](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list) | This API is used to obtain the third-party approval status. After a user enters the query condition, the API returns the status of the approval instances that meet the condition.The API supports a combination of multiple parameters, including the following: 1. Obtain the task status of a specified instance by using instance_ids 2. Obtain the task status of a specified user by using user_ids 3. Obtain all the tasks of a specified status by using status 4. Obtain the next batch of data |
|
|
145
|
+
| approval.v4.instance.addSign | [Add approvers](https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign) | Approval-Approval tasks-Add approvers |
|
|
146
|
+
| approval.v4.instance.cancel | [Revoke approval instances](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cancel) | If the enterprise administrator selects **Allow to revoke a request awaiting approval** or **Allow to revoke requests within x days** in the **More** of a specific approval definition in the approval backend, you can call this interface to revoke the approval instance of the specified submitter under the conditions that meet the revocation rules |
|
|
147
|
+
| approval.v4.instance.cc | [Notify someone of approval instances](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cc) | Calling this API will CC the current approval instance to the specified user. The CC'ed user can view the approval instance details. For example, they can see the approval instance in the Feishu client under **Workplace > Approval > Approval Center > CC'd** list |
|
|
148
|
+
| approval.v4.instanceComment.create | [Create comments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/create) | Create or modify comments, or comment on replies under an approval instance (excluding approved, rejected, transferred, and other additional reasons or opinions) |
|
|
149
|
+
| approval.v4.instanceComment.delete | [Delete comments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/delete) | Delete a comment or a reply under a specific approval instance (excluding additional reasons or opinions such as approval, rejection, transfer, etc.). After deletion, the comment will no longer be displayed in the approval instance in the approval center, but instead will show **Comment Deleted** |
|
|
150
|
+
| approval.v4.instanceComment.list | [Receive comments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list) | Obtain all comments and replies to comments under an approval instance according to Instance Code (excluding approved, rejected, transferred, and other additional reasons or opinions) |
|
|
151
|
+
| approval.v4.instanceComment.remove | [Clear comments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/remove) | Delete all comments and replies to comments under an approval instance (excluding approved, rejected, transferred, and other additional reasons or opinions) |
|
|
152
|
+
| approval.v4.instance.create | [Create an approval instance](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/create) | To call this interface and create an approval instance using a specified approval definition code, the caller needs to have a detailed understanding of the approval definition form. According to the defined form structure, the form values should be passed in through this interface |
|
|
153
|
+
| approval.v4.instance.get | [Obtain details of an approval instance](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get) | You can obtain detailed information about a specific approval instance using the Approval Instance Code, including the name of the approval instance, creation time, user who initiated the approval, status, and task list, among other information |
|
|
154
|
+
| approval.v4.instance.list | [Obtain IDs of multiple approval instances](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list) | This API is used to obtain the instance_codes of multiple approval instances in batches based on a specified approval_code. This can be used to obtain all approval instances of a tenant's approval definition.The results are sorted by default in the order of when the approval was created |
|
|
155
|
+
| approval.v4.instance.preview | [Preview approval instances](https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview) | Approval-Approval instances-Preview approval instances |
|
|
156
|
+
| approval.v4.instance.query | [List of instances](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query) | The interface queries the list of qualified review instances in the review system through different conditions |
|
|
157
|
+
| approval.v4.instance.searchCc | [List of cc information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc) | The interface queries the qualified review cc list in the review system through different conditions |
|
|
158
|
+
| approval.v4.instance.specifiedRollback | [Return approval task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback) | Rolls back the current approval to one or more approved task nodes. After the rollback, the approved nodes will generate approval tasks again |
|
|
159
|
+
| approval.v4.task.approve | [Agree to approval task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve) | Approves a single approval task. After that, the approval process will be transferred to the next approver |
|
|
160
|
+
| approval.v4.task.query | [Query the user's task list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query) | Approval-Approval search-Query the user's task list |
|
|
161
|
+
| approval.v4.task.reject | [Refuse to approve tasks](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/reject) | Rejects a single approval task. This ends the approval process |
|
|
162
|
+
| approval.v4.task.resubmit | [Resubmit the task for approval](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/resubmit) | For the approval tasks that are returned to the initiator, the reinitiation operation can be performed. After initiation, the approval process will move to the next approver |
|
|
163
|
+
| approval.v4.task.search | [Query list of tasks](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search) | The interface queries the list of qualified review tasks in the review system through different conditions |
|
|
164
|
+
| approval.v4.task.transfer | [Transfer the approval task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/transfer) | Transfers a single approval task. After that, the approval process will be transferred to the transfer recipient |
|
|
165
|
+
|
|
166
|
+
## Business domain: attendanceV1
|
|
167
|
+
| MCP Tool Name | API | Description |
|
|
168
|
+
| --- | --- | --- |
|
|
169
|
+
| attendance.v1.approvalInfo.process | [Notify approval status update](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/approval_info/process) | For enterprises that only use Feishu Attendance but not Feishu Approval, through this interface, the approval status of the third-party system written in the Feishu Attendance can be updated such as leave, overtime, out of office, business trip, correction, etc. and the approval status including approve, reject, revoke, etc |
|
|
170
|
+
| attendance.v1.archiveRule.delReport | [Delete archived report row data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/del_report) | Delete archived report row data directly by month, user, and archive rule ID |
|
|
171
|
+
| attendance.v1.archiveRule.list | [Query all archived reports](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/list) | Query all archiving rules, corresponding to the background fake attendance management - attendance statistics - reports - [archived reports] function |
|
|
172
|
+
| attendance.v1.archiveRule.uploadReport | [Write archived report results](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/upload_report) | Write the results of the archived report, corresponding to the fake attendance management - attendance statistics - report - [archived report tab], click the import function after the report name is entered. You can directly write the data to the archived report |
|
|
173
|
+
| attendance.v1.archiveRule.userStatsFieldsQuery | [Query archived report header](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/archive_rule/user_stats_fields_query) | Query the header of the archived report, corresponding to the background fake attendance management - attendance statistics - report - [archived report]. The archived report supports the reference system report, which can set the archived time and data archiving period, and supports the selection of personnel according to the department/personnel, country/region, personnel type, work location, rank, sequence, and position |
|
|
174
|
+
| attendance.v1.group.create | [Create or modify attendance groups](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/create) | The attendance team is a rule setting for the attendance of departments or employees in a specific place and within a specific time period (including commuting, arriving late, leaving early, sick leave, marriage leave, bereavement leave, public holidays, working hours, overtime, etc.).By setting the attendance group, you can set attendance methods, attendance time, attendance location and other attendance rules from the two dimensions of departments and employees.The corresponding function is the same as the settings - fake attendance settings - "new" function of [attendance group] |
|
|
175
|
+
| attendance.v1.group.delete | [Delete attendance group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/delete) | Delete the attendance group through the attendance group ID. Corresponding Settings - False Attendance Settings - Delete Function of [Attendance Group] Operation Columns |
|
|
176
|
+
| attendance.v1.group.get | [Query attendance group by ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/get) | Get the attendance group details through the attendance group ID. Including basic information, attendance shifts, attendance methods, and attendance setting information |
|
|
177
|
+
| attendance.v1.group.list | [Query all attendance groups](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list) | Turn the page to get a list of all attendance groups. Include attendance group name and attendance group id |
|
|
178
|
+
| attendance.v1.group.listUser | [Query all members in the attendance group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/list_user) | Query all members in the specified attendance group |
|
|
179
|
+
| attendance.v1.group.search | [Query attendance group by name](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/group/search) | Query the summary information of the attendance group by the name of the attendance group. The query conditions support two methods: exact matching and fuzzy matching of the name. The query results are sorted by the modification time of the attendance group desc, and the maximum number of records is 10. Corresponding page settings - fake attendance settings - [attendance group] name search function |
|
|
180
|
+
| attendance.v1.leaveAccrualRecord.patch | [Modify Grant Record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/leave_accrual_record/patch) | Update the number and expiration date of issuance records, corresponding to leave management - leave management - [issuance records] |
|
|
181
|
+
| attendance.v1.leaveEmployExpireRecord.get | [Get grant record by expiration time](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/leave_employ_expire_record/get) | Only grant records that expired in the corresponding time period can be obtained |
|
|
182
|
+
| attendance.v1.shift.create | [Create Attendance Shift](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/create) | Shift is a general term that describes the time rules of an attendance task, such as how many times a day to play the card, the commute time of each card, how long is late, how long is late, and how long is missing the card. Click on the shift name in the fake work settings - [shift settings] to view the shift details. If the shift id is passed into the imported parameter, then the ability to edit the shift is supported |
|
|
183
|
+
| attendance.v1.shift.delete | [Delete Attendance Shift](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/delete) | Delete the shift by the shift ID. The corresponding function is the Delete button in the operation bar in the shift list of false attendance settings - [shift settings] |
|
|
184
|
+
| attendance.v1.shift.get | [Query shifts by ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/get) | Get the shift details through the shift ID. The corresponding function is fake duty settings - [shift settings] The specific shift in the shift list, the shift information can be viewed by clicking the shift name |
|
|
185
|
+
| attendance.v1.shift.list | [Query all shifts](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/list) | Fake duty settings in Feishu personnel management background - [Shift configuration] page turn query all shift functions, showing shift name, clock in rules, flexible shift rules, rest rules, etc |
|
|
186
|
+
| attendance.v1.shift.query | [Query Attendance Shift by Name](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/shift/query) | Feishu personnel management background fake work settings - [shift configuration] in the search shift name function, showing shift name, clock in rules, flexible shift rules, rest rules, etc |
|
|
187
|
+
| attendance.v1.userApproval.create | [Add approval result](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/create) | Since some companies may use their own approval system instead of Feishu Approval, employees' leave and overtime data cannot flow into the Feishu Attendance. As a result, employees still receive check-in reminders during the leave period and are recorded as No Record.For these companies that only use the Feishu Attendance, but not the Feishu Approval, they can import 3rd party approval data to Feishu Attendance using this attendance API |
|
|
188
|
+
| attendance.v1.userApproval.query | [Get approval data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_approval/query) | This interface is used to get granted approval data of employees' leave, overtime, out of office and business trip over a certain period of time |
|
|
189
|
+
| attendance.v1.userDailyShift.batchCreate | [Create or modify schedule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/batch_create) | The schedule is used to describe which shift the personnel in the attendance group go to work every day. Currently, the schedule supports scheduling one or more personnel by x month y day. It will be created when the user's schedule data does not exist, and will be modified according to the imported parameter information when the user's schedule data exists. Note: Each person can only be in one attendance group per day |
|
|
190
|
+
| attendance.v1.userDailyShift.batchCreateTemp | [Create or modify temporary schedule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/batch_create_temp) | Temporary shifts can be created or modified on the schedule and used for scheduling. Temporary shifts are currently supported for one or more people by date. Temporary shifts are paid features, please contact your account manager to use them |
|
|
191
|
+
| attendance.v1.userDailyShift.query | [Query schedule information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_daily_shift/query) | Support querying the scheduling of multiple users. Note that this interface returns the scheduling results of the user dimension, which does not correspond to the page function. You can query the attendance group [query the attendance group by ID] through the group_id in the return result, shift_id query the shift [query the shift by ID]. The time span of the query cannot exceed 30 days |
|
|
192
|
+
| attendance.v1.userFlow.batchCreate | [Import attendance record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/batch_create) | Import the employee's attendance details. After importing, the final clock in status and result will be calculated according to the shift rules of the employee's attendance team. You can check in clock in management - [clock in records] |
|
|
193
|
+
| attendance.v1.userFlow.batchDel | [delete attendance record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/batch_del) | Delete the clock in record imported by the employee from the open platform. After deletion, the clock in record will be recalculated corresponding to the attendance task result |
|
|
194
|
+
| attendance.v1.userFlow.get | [Obtain attendance record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/get) | Obtain the user's attendance details record through the record ID of the clock. The return information mainly includes:* User ID and creator ID* Record information* clock in position information, time information* Information in clock mode* GPS clock in: location_name (location address information)* Wi-Fi clock in: ssid (wifi name), bssid (mac address)* Attendance machine clock in: device_id (attendance machine device id)Corresponding page function clock in management - [clock in record] |
|
|
195
|
+
| attendance.v1.userFlow.query | [Batch query attendance record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_flow/query) | Get the user's attendance details through the user ID. The return information mainly includes:* User ID and creator ID* Record information* clock in position information, time information* Information in clock mode* GPS clock in: location_name (location address information)* Wi-Fi clock in: ssid (wifi name), bssid (mac address)* Attendance machine clock in: device_id (attendance machine device id)Corresponding page function clock in management - [clock in record] |
|
|
196
|
+
| attendance.v1.userSetting.modify | [Modify user face recognition information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/modify) | Modify the user settings information of the employee within the authorization, including the face photo file ID. Modifying the user's facial recognition information currently only supports API modification, and the management background cannot be modified |
|
|
197
|
+
| attendance.v1.userSetting.query | [Query user face recognition information in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_setting/query) | Batch query the user setting information of employees within the authorization, including face photo file ID and face photo update time. Corresponding page fake attendance settings - [facial recognition]. According to the returned face_key, you can download face information [Download user facial recognition photos] |
|
|
198
|
+
| attendance.v1.userStatsData.query | [Query statistical data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_data/query) | Query statistics for daily or monthly statistics. Fields contain basic information, attendance group information, attendance statistics, exception statistics, leave statistics, overtime statistics, clock in time, attendance results, and custom fields. Specific reports can be found in Attendance Statistics - [Reports] |
|
|
199
|
+
| attendance.v1.userStatsField.query | [Query statistics headers](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_field/query) | Query the statistical header of the daily statistics or monthly statistics supported by the attendance statistics. The header information of the report can be queried in the attendance statistics - [report] to find the specific report information. This interface is specially used to query the header data |
|
|
200
|
+
| attendance.v1.userStatsView.query | [Query statistics settings](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_view/query) | Query the statistical header of the daily statistics or monthly statistics supported by the attendance statistics. The header information of the report can be queried in the attendance statistics - [report]. This interface is specially used to query the header data. Note that this interface is basically the same as the [Query statistics headers]. The difference is that it is compatible with the historical statistics view model (the historical statistics model can be set by user ID, and the subsequent statistics are upgraded to support only the tenant dimension) |
|
|
201
|
+
| attendance.v1.userStatsView.update | [Update statistics settings](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_stats_view/update) | Update the statistical report header setting information customized by the developer for daily statistics or monthly statistics. The header information of the report can be found in the attendance statistics - [report]. This interface is specially used to update the header information |
|
|
202
|
+
| attendance.v1.userTaskRemedy.create | [Notify correction approval initiation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/create) | For enterprises that only use Fishu attendance system but not Fishu approval system, you can use this interface to write the replacement card approval data initiated in the three-party approval system to Fishu attendance system with the status of approval in progress. The status can be updated by [notify approval status update] after writing in |
|
|
203
|
+
| attendance.v1.userTaskRemedy.query | [Obtain correction record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/query) | Supplementary card: The user adds a clock in record within the time frame of a certain commute/get off work by means of approval to correct the user's attendance result. This interface is dedicated to obtaining the supplementary card records of employees (no page function corresponds) |
|
|
204
|
+
| attendance.v1.userTaskRemedy.queryUserAllowedRemedys | [Obtain the time allowing for user's correction](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task_remedy/query_user_allowed_remedys) | Obtains the number of punch in/off the user can correct for a given day |
|
|
205
|
+
| attendance.v1.userTask.query | [Obtain attendance result](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task/query) | Get the results of the actual clock in the enterprise, including:* clock in task list* ID in clock* User information* Attendance Team ID* shift id* Attendance records* Work record* Off-duty records* Results in work clock* Results in clock* Results added in work clock* Results added in clock* Work clock in time* Time in clockList of invalid user IDs* List of user IDs without permission |
|
|
206
|
+
|
|
207
|
+
## Business domain: authV3
|
|
208
|
+
| MCP Tool Name | API | Description |
|
|
209
|
+
| --- | --- | --- |
|
|
210
|
+
| auth.v3.auth.appAccessToken | [Store applications get app_access_token](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token) | Authenticate and Authorize-Get Access Tokens-Store applications get app_access_token |
|
|
211
|
+
| auth.v3.auth.appAccessTokenInternal | [Get custom app app_access_token](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token_internal) | Authenticate and Authorize-Get Access Tokens-Get custom app app_access_token |
|
|
212
|
+
| auth.v3.auth.appTicketResend | [Retrieve app_ticket](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_ticket_resend) | Authenticate and Authorize-Get Access Tokens-Retrieve app_ticket |
|
|
213
|
+
| auth.v3.auth.tenantAccessToken | [Store applications get tenant_access_token](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token) | Authenticate and Authorize-Get Access Tokens-Store applications get tenant_access_token |
|
|
214
|
+
| auth.v3.auth.tenantAccessTokenInternal | [Get custom app tenant_access_token](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal) | Authenticate and Authorize-Get Access Tokens-Get custom app tenant_access_token |
|
|
215
|
+
|
|
216
|
+
## Business domain: authenV1
|
|
217
|
+
| MCP Tool Name | API | Description |
|
|
218
|
+
| --- | --- | --- |
|
|
219
|
+
| authen.v1.userInfo.get | [Get User Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/user_info/get) | Get related user info via `user_access_token` |
|
|
220
|
+
|
|
221
|
+
## Business domain: baikeV1
|
|
222
|
+
| MCP Tool Name | API | Description |
|
|
223
|
+
| --- | --- | --- |
|
|
224
|
+
| baike.v1.classification.list | [Classification list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list) | Get Lingo classification data, Baike currently supports primary classification and sub-classification, temporarily does not support multi-level classification |
|
|
225
|
+
| baike.v1.draft.create | [Create draft](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/create) | Drafts are separate definitions and are not bound to entity words. Creating drafts is not the same as creating entity words. Creating drafts may be creating entity words or updating entity words |
|
|
226
|
+
| baike.v1.draft.update | [Update draft](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/update) | Update draft content according to draft_id, approved drafts cannot be edited |
|
|
227
|
+
| baike.v1.entity.create | [Create an exemption entry](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create) | Create the existing entries through this interface, do not need Lingo a moderator review can be written directly to the thesaurus, please use carefully [tenant moderator please review carefully] |
|
|
228
|
+
| baike.v1.entity.extract | [Extract lingo entity words](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract) | Extract physical words in the text that could become Baike entries and recommend possible aliases (does not filter content where tenants have become Baike entries) |
|
|
229
|
+
| baike.v1.entity.get | [Get entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get) | Pull the corresponding entity details through the entity id |
|
|
230
|
+
| baike.v1.entity.highlight | [Highlight entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight) | The user passes in a sentence and returns the position and corresponding Id of the entity word, allowing the user to highlight the entity word |
|
|
231
|
+
| baike.v1.entity.list | [Get entities](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list) | Paging entity word data to support all entity word pulling within the tenant |
|
|
232
|
+
| baike.v1.entity.match | [Match entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match) | Accurately match the keywords, full names, and alias attributes of entity words, and recall the corresponding IDs |
|
|
233
|
+
| baike.v1.entity.search | [Search entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search) | Passing in keywords, performing fuzzy matching to search for corresponding entity words |
|
|
234
|
+
| baike.v1.entity.update | [Update the exemption entry](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update) | Update the existing entries through this interface, do not need Lingo moderator review can be written directly to the thesaurus, please use carefully [tenant moderator please review carefully] |
|
|
235
|
+
|
|
236
|
+
## Business domain: baseV2
|
|
237
|
+
| MCP Tool Name | API | Description |
|
|
238
|
+
| --- | --- | --- |
|
|
239
|
+
| base.v2.appRole.create | [Create role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/advanced-permission/base-v2/app-role/create) | Create a role |
|
|
240
|
+
| base.v2.appRole.list | [List roles](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/advanced-permission/base-v2/app-role/list) | Get all roles according to app_token |
|
|
241
|
+
| base.v2.appRole.update | [Update role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/advanced-permission/base-v2/app-role/update) | Update a role |
|
|
242
|
+
|
|
243
|
+
## Business domain: bitableV1
|
|
244
|
+
| MCP Tool Name | API | Description |
|
|
245
|
+
| --- | --- | --- |
|
|
246
|
+
| bitable.v1.app.copy | [Copy App](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy) | Copy a base app, you can specify to copy to a folder with permissions |
|
|
247
|
+
| bitable.v1.app.create | [Create a Base App](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create) | Create a base app in user-defined folder |
|
|
248
|
+
| bitable.v1.appDashboard.copy | [Copy dashboards](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/copy) | This interface is used to duplicate a new dashboard from an existing dashboard |
|
|
249
|
+
| bitable.v1.appDashboard.list | [List dashboards](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list) | According to app_token, get all dashboards under app |
|
|
250
|
+
| bitable.v1.app.get | [Get App Info](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get) | Get App information through app_token |
|
|
251
|
+
| bitable.v1.appRole.create | [Create role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create) | Create a role |
|
|
252
|
+
| bitable.v1.appRole.delete | [Delete role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete) | Delete a role |
|
|
253
|
+
| bitable.v1.appRole.list | [List roles](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list) | Get all roles according to app_token |
|
|
254
|
+
| bitable.v1.appRoleMember.batchCreate | [Batch create members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_create) | Add role members with custom permissions in bulk |
|
|
255
|
+
| bitable.v1.appRoleMember.batchDelete | [Batch delete members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete) | Batch delete role members |
|
|
256
|
+
| bitable.v1.appRoleMember.create | [Create member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create) | Create a member |
|
|
257
|
+
| bitable.v1.appRoleMember.delete | [Delete member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete) | Delete a member |
|
|
258
|
+
| bitable.v1.appRoleMember.list | [List members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list) | Get all members according to app_token and role_id |
|
|
259
|
+
| bitable.v1.appRole.update | [Update role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/update) | Update a role |
|
|
260
|
+
| bitable.v1.appTable.batchCreate | [Batch create table](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create) | Batch create table |
|
|
261
|
+
| bitable.v1.appTable.batchDelete | [Batch delete table](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete) | Batch delete table |
|
|
262
|
+
| bitable.v1.appTable.create | [Create table](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create) | Add a new table in Base, supporting the input of table name, view name, and fields |
|
|
263
|
+
| bitable.v1.appTable.delete | [Delete Table](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete) | Delete a table |
|
|
264
|
+
| bitable.v1.appTableField.create | [Create field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/create) | Create a field |
|
|
265
|
+
| bitable.v1.appTableField.delete | [Delete field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete) | Delete a field |
|
|
266
|
+
| bitable.v1.appTableField.list | [List fields](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list) | Get all fields according to app_token and table_id |
|
|
267
|
+
| bitable.v1.appTableField.update | [Update field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/update) | Update a field |
|
|
268
|
+
| bitable.v1.appTableFormField.list | [List form fields](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/list) | Give all form fields according to app_token, table_id and form_id |
|
|
269
|
+
| bitable.v1.appTableFormField.patch | [Patch form fields](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/patch) | Update a form field |
|
|
270
|
+
| bitable.v1.appTableForm.get | [List form](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/get) | Give form according to app_token, table_id and form_id |
|
|
271
|
+
| bitable.v1.appTableForm.patch | [Patch form](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch) | Update a form |
|
|
272
|
+
| bitable.v1.appTable.list | [List all tables](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list) | According to app_token, get all tables under app |
|
|
273
|
+
| bitable.v1.appTable.patch | [Update data table](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/patch) | This interface is used to update the basic information of the data table, including the name of the data table, etc |
|
|
274
|
+
| bitable.v1.appTableRecord.batchCreate | [Create records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_create) | Create records,up to 500 lines at a time |
|
|
275
|
+
| bitable.v1.appTableRecord.batchDelete | [Delete records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_delete) | Delete records,up to 500 lines at a time |
|
|
276
|
+
| bitable.v1.appTableRecord.batchGet | [Batch get records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_get) | Batch get records by record ids |
|
|
277
|
+
| bitable.v1.appTableRecord.batchUpdate | [Update records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_update) | Update records,up to 500 lines at a time |
|
|
278
|
+
| bitable.v1.appTableRecord.create | [Create a record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create) | Create a record |
|
|
279
|
+
| bitable.v1.appTableRecord.delete | [Delete a record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete) | Delete a record |
|
|
280
|
+
| bitable.v1.appTableRecord.get | [Get records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/get) | Get records |
|
|
281
|
+
| bitable.v1.appTableRecord.list | [List records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/list) | list records,Up to 500 lines at a time, paging is supported(Currently, the return of search reference fields are not supported. The search reference field can be converted into a formula field. The search reference is essentially a lookup formula) |
|
|
282
|
+
| bitable.v1.appTableRecord.search | [Search records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search) | 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 |
|
|
283
|
+
| bitable.v1.appTableRecord.update | [Update a record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/update) | Update a record |
|
|
284
|
+
| bitable.v1.appTableView.create | [Add View](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create) | Add a view to the data table |
|
|
285
|
+
| bitable.v1.appTableView.delete | [Delete View](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete) | Delete views from data tables |
|
|
286
|
+
| bitable.v1.appTableView.get | [Get View](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get) | This interface gets existing views based on view_id |
|
|
287
|
+
| bitable.v1.appTableView.list | [List Views](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list) | Get all views of the data table based on app_token and table_id |
|
|
288
|
+
| bitable.v1.appTableView.patch | [Update View](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch) | This interface is used to incrementally modify view information |
|
|
289
|
+
| bitable.v1.app.update | [Update App Name](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update) | Update app information according to app_token |
|
|
290
|
+
| bitable.v1.appWorkflow.list | [List automations](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/list) | This interface is used to list the automations of base |
|
|
291
|
+
| bitable.v1.appWorkflow.update | [update workflow](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/update) | This interface can be used to update Workflow status |
|
|
292
|
+
|
|
293
|
+
## Business domain: boardV1
|
|
294
|
+
| MCP Tool Name | API | Description |
|
|
295
|
+
| --- | --- | --- |
|
|
296
|
+
| board.v1.whiteboardNode.list | [list nodes](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/list) | Obtain all nodes of a board |
|
|
297
|
+
|
|
298
|
+
## Business domain: calendarV4
|
|
299
|
+
| MCP Tool Name | API | Description |
|
|
300
|
+
| --- | --- | --- |
|
|
301
|
+
| calendar.v4.calendarAcl.create | [Create ACL](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/create) | Call this interface to add access control to the specified calendar in your current identity (application or user), that is, calendar member permissions |
|
|
302
|
+
| calendar.v4.calendarAcl.delete | [Delete ACL](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/delete) | Call this interface to delete a certain access control in the specified calendar with the current identity (application or user), i.e., member permissions |
|
|
303
|
+
| calendar.v4.calendarAcl.list | [Obtain the ACL](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/list) | Call this interface to get the access control list of the specified calendar as the current identity (application or user) |
|
|
304
|
+
| calendar.v4.calendarAcl.subscription | [Subscribe ACL Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/subscription) | Call this interface in the identity of the user to subscribe to access control change events under the specified calendar |
|
|
305
|
+
| calendar.v4.calendarAcl.unsubscription | [Unsubscribe ACL Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-acl/unsubscription) | Invoke this interface in the user's identity to unsubscribe from access control change events under the specified calendar |
|
|
306
|
+
| calendar.v4.calendar.create | [Create a shared calendar](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/create) | Call this interface to create a shared calendar for the current identity (app or user) |
|
|
307
|
+
| calendar.v4.calendar.delete | [Delete shared calendar](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/delete) | Call this interface to delete a specified shared calendar under the current identity (application or user) |
|
|
308
|
+
| calendar.v4.calendarEventAttendee.batchDelete | [Delete event invitees](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/batch_delete) | Call this interface to delete one or more invitees of the specified event with the current identity (app or user) |
|
|
309
|
+
| calendar.v4.calendarEventAttendeeChatMember.list | [Obtain the list of members of group invitees of an event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list) | Call this interface with the current identity (app or user) to get the group member list of the group type invitees in the event |
|
|
310
|
+
| calendar.v4.calendarEventAttendee.create | [Create event invitees](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/create) | 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 |
|
|
311
|
+
| calendar.v4.calendarEventAttendee.list | [Obtain event invitee list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee/list) | Call this interface to retrieve the list of invitees for a event with the current identity (app or user) |
|
|
312
|
+
| calendar.v4.calendarEvent.create | [Create event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/create) | Call this interface to create a event on the specified calendar with the current identity (application or user) |
|
|
313
|
+
| calendar.v4.calendarEvent.delete | [Delete Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/delete) | Call this interface to delete an event on the specified calendar with the current identity (application or user) |
|
|
314
|
+
| calendar.v4.calendarEvent.get | [Get Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/get) | 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 |
|
|
315
|
+
| calendar.v4.calendarEvent.instanceView | [Query event view](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instance_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 |
|
|
316
|
+
| calendar.v4.calendarEvent.instances | [Get Event instances](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instances) | Call this interface with the current identity (app or user) to obtain information about a specific recurring event in a specified calendar |
|
|
317
|
+
| calendar.v4.calendarEvent.list | [Get Event List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/list) | Call this interface with the current identity (app or user) to obtain the event list under a specified calendar |
|
|
318
|
+
| calendar.v4.calendarEventMeetingChat.create | [Create meeting chat](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_chat/create) | Call this interface in the current identity (app or user) to create a meeting group for a specific event |
|
|
319
|
+
| calendar.v4.calendarEventMeetingChat.delete | [Unbind meeting chat](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_chat/delete) | Call this interface in the current identity (app or user) to unbind the created meeting group for the event |
|
|
320
|
+
| calendar.v4.calendarEventMeetingMinute.create | [Create meeting minute](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-meeting_minute/create) | 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 |
|
|
321
|
+
| calendar.v4.calendarEvent.patch | [Update Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/patch) | 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 |
|
|
322
|
+
| calendar.v4.calendarEvent.reply | [Reply Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/reply) | Call this interface to reply to the event with the current identity (app or user) |
|
|
323
|
+
| calendar.v4.calendarEvent.search | [Search Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search) | Call this interface to search for relevant events under the specified calendar, supporting keyword search and filter condition search |
|
|
324
|
+
| calendar.v4.calendarEvent.subscription | [Subscribe Event Changes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/subscription) | Call this interface with user identity to subscribe to event change events under a specified calendar |
|
|
325
|
+
| calendar.v4.calendarEvent.unsubscription | [Unsubscribe Event Changes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/unsubscription) | Call this interface to unsubscribe from event change events in the specified calendar as a user |
|
|
326
|
+
| calendar.v4.calendar.get | [Query calendar information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get) | Call this interface to query the information of a specified calendar with the current identity (application or user) |
|
|
327
|
+
| calendar.v4.calendar.list | [Query the calendar list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list) | Call this interface to page through and query the calendar list of the current identity (application or user) |
|
|
328
|
+
| calendar.v4.calendar.patch | [Update calendar information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/patch) | Call this interface with the current identity (application or user) to modify the title, description, public range, and other information of the specified calendar |
|
|
329
|
+
| calendar.v4.calendar.primary | [Query primary calendar information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary) | Call this interface to get the main calendar information of the current identity (application or user) |
|
|
330
|
+
| calendar.v4.calendar.search | [Search Calendar](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/search) | 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 |
|
|
331
|
+
| calendar.v4.calendar.subscribe | [Subscribe Calendar](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscribe) | Call this interface to subscribe to the specified calendar with the current identity (application or user) |
|
|
332
|
+
| calendar.v4.calendar.subscription | [Subscribe Calendar Changes ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscription) | Call this interface to subscribe the current user identity to the [Calendar Change Event] |
|
|
333
|
+
| calendar.v4.calendar.unsubscribe | [Unsubscribe Calendar](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscribe) | Call this interface with the current identity (application or user) to unsubscribe from the specified calendar |
|
|
334
|
+
| calendar.v4.calendar.unsubscription | [Unsubscribe Calendar Changes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscription) | Call this interface to unsubscribe the current user identity from the [Calendar Change Event] |
|
|
335
|
+
| calendar.v4.exchangeBinding.create | [Bind Exchange account to Feishu account](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/create) | Call this interface to bind the Exchange account to the Feishu account, thereby supporting the import of the Exchange calendar |
|
|
336
|
+
| calendar.v4.exchangeBinding.delete | [Unbind the Exchange account](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/delete) | Call this interface to unbind the relationship between the Exchange account and the Feishu account. After the Exchange account is unbound, it can continue to bind with other Feishu accounts |
|
|
337
|
+
| calendar.v4.exchangeBinding.get | [Query the binding status of the Exchange account](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/get) | Call this interface to obtain the binding status of the Exchange account, including the synchronization status of the Exchange calendar |
|
|
338
|
+
| calendar.v4.freebusy.list | [Query availability of the primary calendar](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/list) | 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 |
|
|
339
|
+
| calendar.v4.setting.generateCaldavConf | [Generate CalDAV configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/setting/generate_caldav_conf) | Call this interface to generate a CalDAV account password for the current user, which is used to synchronize Feishu calendar information to the local device calendar |
|
|
340
|
+
| calendar.v4.timeoffEvent.create | [Create Timeoff Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/timeoff_event/create) | Call this interface to create a leave event for a specified user. Leave events are divided into regular events and all-day events. After creating a leave event, the user's personal signature page will display leave information during the leave time |
|
|
341
|
+
| calendar.v4.timeoffEvent.delete | [Delete Timeoff Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/timeoff_event/delete) | Call this interface to delete a specified leave event. After the leave event is deleted, the leave information on the user's personal signature page will also disappear |
|
|
342
|
+
|
|
343
|
+
## Business domain: cardkitV1
|
|
344
|
+
| MCP Tool Name | API | Description |
|
|
345
|
+
| --- | --- | --- |
|
|
346
|
+
| cardkit.v1.card.batchUpdate | [Batch update card entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update) | Batch update card |
|
|
347
|
+
| cardkit.v1.card.create | [Create card entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/create) | Create a card entity based on the card JSON code or the cardkit tool |
|
|
348
|
+
| cardkit.v1.cardElement.content | [Stream update text](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/content) | Pass the full text content to a plain text element (tagged as `plain_text`) or a rich text component (tagged as `markdown`) in the card to achieve a "typewriter" effect for text output. Refer to [Streaming Updates for Cards] to understand the complete process of streaming text updates |
|
|
349
|
+
| cardkit.v1.cardElement.create | [Insert element](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/create) | Insert Element |
|
|
350
|
+
| cardkit.v1.cardElement.delete | [Delete element](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/delete) | Delete Element |
|
|
351
|
+
| cardkit.v1.cardElement.patch | [Patch Update Element](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/patch) | Update Element Attribute |
|
|
352
|
+
| cardkit.v1.cardElement.update | [Update element](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card-element/update) | Update Element |
|
|
353
|
+
| cardkit.v1.card.idConvert | [Convert ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/id_convert) | ID Convert |
|
|
354
|
+
| cardkit.v1.card.settings | [Update card config](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings) | Updates the configuration of a given card entity, supporting updates to the config and card_link fields |
|
|
355
|
+
| cardkit.v1.card.update | [Update card entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/update) | Update card entity |
|
|
356
|
+
|
|
357
|
+
## Business domain: compensationV1
|
|
358
|
+
| MCP Tool Name | API | Description |
|
|
359
|
+
| --- | --- | --- |
|
|
360
|
+
| compensation.v1.archive.query | [Batch query compensation profile](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/archive/query) | Batch query compensation profile |
|
|
361
|
+
| compensation.v1.changeReason.list | [Batch query reason for compensation setting and adjustment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/change_reason/list) | Batch query reason for compensation setting and adjustment |
|
|
362
|
+
| compensation.v1.indicator.list | [Batch query compensation metric](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/indicator/list) | Batch query compensation metric |
|
|
363
|
+
| compensation.v1.itemCategory.list | [Batch query compensation component type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item_category/list) | Batch query compensation component type |
|
|
364
|
+
| compensation.v1.item.list | [Batch query compensation component](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/item/list) | Batch query compensation component |
|
|
365
|
+
| compensation.v1.plan.list | [Batch query compensation plan](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/compensation-v1/plan/list) | - This interface will return all salary plan information, including salary plan ID, effective date, salary item/salary statistics indicator, etc |
|
|
366
|
+
|
|
367
|
+
## Business domain: contactV3
|
|
368
|
+
| MCP Tool Name | API | Description |
|
|
369
|
+
| --- | --- | --- |
|
|
370
|
+
| contact.v3.customAttr.list | [Obtain custom user fields](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list) | Call this interface to query the configuration information of custom user fields in the current enterprise |
|
|
371
|
+
| contact.v3.department.batch | [Obtain bulk department information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/batch) | Call this interface to obtain information about one or more departments, including department name, ID, parent department, person in charge, status, number of members, etc |
|
|
372
|
+
| contact.v3.department.children | [Obtain the list of sub-departments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children) | Call this interface to query the list of sub-departments under the specified department. The list contains information such as the department's name, ID, parent department, person in charge, and status |
|
|
373
|
+
| contact.v3.department.create | [Create a department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create) | Call this interface to create a department in the contacts |
|
|
374
|
+
| contact.v3.department.delete | [Delete a department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete) | Call this interface to delete the specified department from the contacts |
|
|
375
|
+
| contact.v3.department.get | [Obtain single department information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get) | Call this interface to obtain information about a single department, including department name, ID, parent department, person in charge, status, number of members, etc |
|
|
376
|
+
| contact.v3.department.list | [Get Department Information List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list) | This API is used to obtain the list of sub-departments of a department. [FAQs] |
|
|
377
|
+
| contact.v3.department.parent | [Obtain parent department information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent) | Call this interface to recursively obtain the parent department information of the specified department, including department name, ID, person in charge, status, etc |
|
|
378
|
+
| contact.v3.department.patch | [Modify department information in part](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch) | Call this interface to update some information of the specified department, including name, parent department, sorting, person in charge, etc |
|
|
379
|
+
| contact.v3.department.search | [Search for departments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search) | Call this interface to query the visible department information through the department name keyword as a user, including the department's ID, parent department, person in charge, and status, etc |
|
|
380
|
+
| contact.v3.department.unbindDepartmentChat | [Change department group to common group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat) | Call this interface to convert the department group of the specified department into a normal group |
|
|
381
|
+
| contact.v3.department.update | [Update department information in whole](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update) | Call this interface to update the information of the specified department, including name, parent department, person in charge, etc |
|
|
382
|
+
| contact.v3.department.updateDepartmentId | [Update DepartmentID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update_department_id) | Call this interface to update the department's custom ID, that is, department_id |
|
|
383
|
+
| contact.v3.employeeTypeEnum.create | [Add a workforce type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create) | Call this interface to add a workforce type. Workforce type is one of the user attributes, used to flexibly mark the user's identity type |
|
|
384
|
+
| contact.v3.employeeTypeEnum.delete | [Delete workforce types](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete) | Call this interface to delete the specified custom workforce type |
|
|
385
|
+
| contact.v3.employeeTypeEnum.list | [Query the workforce type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list) | Call this interface to query all workforce type information under the current tenant, including enum ID, type, number, and content |
|
|
386
|
+
| contact.v3.employeeTypeEnum.update | [Update the workforce type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/update) | Call this interface to update the specified custom workforce type information |
|
|
387
|
+
| contact.v3.functionalRole.create | [Create role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/create) | Call this interface to create a role |
|
|
388
|
+
| contact.v3.functionalRole.delete | [Delete role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/delete) | Call this interface to delete the specified role |
|
|
389
|
+
| contact.v3.functionalRoleMember.batchCreate | [Batch create role members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_create) | Call this interface to add one or more members to the specified role |
|
|
390
|
+
| contact.v3.functionalRoleMember.batchDelete | [Delete members from roles](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete) | Call this interface to delete one or more members in the specified role |
|
|
391
|
+
| contact.v3.functionalRoleMember.get | [The administrative scope of a member under a query role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/get) | Call this interface to query the management scope of a specified member within a specified role |
|
|
392
|
+
| contact.v3.functionalRoleMember.list | [Query all member information under the role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list) | Call this interface to query all member information within the specified role, including the member's user ID and management scope |
|
|
393
|
+
| contact.v3.functionalRoleMember.scopes | [Batch update role members scopes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/scopes) | Call this interface to set the management scope for one or more role members in the specified role. The management scope refers to the range of departments that the role member can manage |
|
|
394
|
+
| contact.v3.functionalRole.update | [Update role name](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/update) | Call this interface to modify the role name of the specified role |
|
|
395
|
+
| contact.v3.group.create | [Create a user group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/create) | Call this interface to create a user group. User group is one of the basic entities in Feishu Contacts. Users or department resources can be added to user groups. Various types of business permission control can be associated with user groups to achieve efficient and convenient member permission control |
|
|
396
|
+
| contact.v3.group.delete | [Delete a user group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete) | Call this interface to delete the specified user group |
|
|
397
|
+
| contact.v3.group.get | [Query a user group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/get) | Call this interface to query the basic information of the specified user group through the user group ID, including user group name, number and type of members, etc |
|
|
398
|
+
| contact.v3.group.memberBelong | [Query the user group list to which the user belongs](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong) | Call this interface to query the list of user groups to which the specified user belongs |
|
|
399
|
+
| contact.v3.groupMember.add | [Add members to a user group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/add) | Call this interface to add members to the specified common user group |
|
|
400
|
+
| contact.v3.groupMember.batchAdd | [Batch add user group members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_add) | Call this interface to add one or more members to the specified common user group |
|
|
401
|
+
| contact.v3.groupMember.batchRemove | [Batch remove user group members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_remove) | Call this interface to remove one or more members from the specified common user group |
|
|
402
|
+
| contact.v3.groupMember.remove | [Remove members from a user group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove) | Call this interface to remove a member from the specified common user group |
|
|
403
|
+
| contact.v3.groupMember.simplelist | [List user group member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist) | Call this interface to query the member list in the specified user group. The list mainly includes member ID information |
|
|
404
|
+
| contact.v3.group.patch | [Update a user group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/patch) | Call this interface to update the name or description of the specified user group |
|
|
405
|
+
| contact.v3.group.simplelist | [Query the list of user groups](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist) | Call this interface to query the list of user groups under the current tenant. The list contains information such as the ID, name, number and type of members of the user group |
|
|
406
|
+
| contact.v3.jobFamily.create | [Create a job family](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/create) | Call this interface to create a job family.Call this interface to create a job family. Job family is one of the user attributes, which is used to define the user's work type, such as product, R&D, operation, etc |
|
|
407
|
+
| contact.v3.jobFamily.delete | [Delete a job family](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete) | Call this interface to delete the specified job family |
|
|
408
|
+
| contact.v3.jobFamily.get | [Query a job family](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/get) | Call this interface to obtain the information of the specified job family, including the name, description, enabled status, and ID of the job family |
|
|
409
|
+
| contact.v3.jobFamily.list | [Query the list of job family](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list) | Call this interface to obtain the job family information of the current tenant, including the name, description, enabled status, and ID of the job family |
|
|
410
|
+
| contact.v3.jobFamily.update | [Update job family](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/update) | Call this interface to update the information of the specified job family |
|
|
411
|
+
| contact.v3.jobLevel.create | [Create a job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/create) | Call this interface to create a job level. Job level is one of the user attributes, used to identify the user's position level, such as P1, P2, P3, P4 |
|
|
412
|
+
| contact.v3.jobLevel.delete | [Delete a job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete) | Call this interface to delete the specified job level |
|
|
413
|
+
| contact.v3.jobLevel.get | [Query a job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/get) | Call this interface to obtain the information of the specified job level, including job level name, description, order, status, and multi-language |
|
|
414
|
+
| contact.v3.jobLevel.list | [Query the list of job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list) | Call this interface to obtain the job level information of the current tenant, including job level name, description, order, status, and multi-language |
|
|
415
|
+
| contact.v3.jobLevel.update | [Update job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/update) | Call this interface to update the information of the specified job level |
|
|
416
|
+
| contact.v3.jobTitle.get | [Query a job title](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/get) | Call this interface to obtain the information of the specified job title, including the job title's ID, name, multi-language name, and enabled status |
|
|
417
|
+
| contact.v3.jobTitle.list | [Query the list of job titles](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list) | Call this interface to obtain the job title information of the current tenant, including the job title ID, name, multi-language name, and enabled status |
|
|
418
|
+
| contact.v3.scope.list | [Obtain the contacts permission scope](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/scope/list) | This API is used to obtain the range of contacts data that an app is authorized to access, including the department list, user list, and user group list |
|
|
419
|
+
| contact.v3.unit.bindDepartment | [Associate a department with a unit](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/bind_department) | Call this interface to establish the binding relationship between a department and an organization. A department can only be bound to one organization at a time |
|
|
420
|
+
| contact.v3.unit.create | [Create a unit](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/create) | Call this interface to create a unit |
|
|
421
|
+
| contact.v3.unit.delete | [Delete units](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete) | Call this interface to delete the specified unit |
|
|
422
|
+
| contact.v3.unit.get | [Obtain unit information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get) | Call this interface to obtain the information of the specified unit, including unit ID, name, and type |
|
|
423
|
+
| contact.v3.unit.list | [List units](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list) | Call this interface to obtain the unit list in the current tenant. The list mainly contains the ID, name, and type information of each unit |
|
|
424
|
+
| contact.v3.unit.listDepartment | [List of departments bound to the unit](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department) | Call this interface to obtain the department list bound to the specified unit |
|
|
425
|
+
| contact.v3.unit.patch | [Modify unit information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/patch) | Call this interface to modify the name of the specified unit |
|
|
426
|
+
| contact.v3.unit.unbindDepartment | [Dissociate a department with a unit](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/unbind_department) | Call this interface to release the binding relationship between a department and an organization |
|
|
427
|
+
| contact.v3.user.batch | [Obtain multiple users' information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch) | Call this interface to obtain the information of one or more users in the address book, including user ID, name, email, mobile phone number, status, department and other information |
|
|
428
|
+
| contact.v3.user.batchGetId | [Obtain user ID via email or mobile number](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id) | Call this interface to obtain the ID (including user_id, open_id, union_id) and status information of one or more users through their mobile phone number or email address |
|
|
429
|
+
| contact.v3.user.create | [Create a user](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create) | Call this interface to create a user in the Contacts (this action can be understood as employee onboarding). After the user is successfully created, the system will send an invitation to the user in the form of a text message or email. The user can only visit the company or team after agreeing to the invitation |
|
|
430
|
+
| contact.v3.user.delete | [Delete a user](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete) | This API is used to delete a user from Contacts when an employee is terminated. When deleting, you can set the transfer object of user data through request parameters |
|
|
431
|
+
| contact.v3.user.findByDepartment | [Obtain the list of users directly under a department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department) | Call this interface to obtain the user information list directly under the specified department. User information includes user ID, name, email, mobile phone number, status and other information |
|
|
432
|
+
| contact.v3.user.get | [Obtain single user's information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get) | Call this interface to obtain the information of a user in the address book, including user ID, name, email, mobile phone number, status, department and other information |
|
|
433
|
+
| contact.v3.user.list | [Get User List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list) | Obtain the list of users directly under the department based on the department ID.[FAQs] |
|
|
434
|
+
| contact.v3.user.patch | [Modify user information in part](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch) | Call this interface to update the information of the specified user in the address book, including name, email, mobile phone number, department, and custom fields |
|
|
435
|
+
| contact.v3.user.resurrect | [Restore deleted users](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/resurrect) | This interface is used to restore deleted users (resigned members) |
|
|
436
|
+
| contact.v3.user.update | [Update user information in whole](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update) | This API is used to update a user's fields in Contacts |
|
|
437
|
+
| contact.v3.user.updateUserId | [Update UserID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update_user_id) | Call this interface to update the user's user_id |
|
|
438
|
+
| contact.v3.workCity.get | [Query a work city](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get) | Call this interface to obtain the information of a specified work city, including the work city's ID, name, multilingual name, and enabled status |
|
|
439
|
+
| contact.v3.workCity.list | [Query the list of work cities](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list) | Call this interface to obtain information about all work cities under the current tenant, including the work city's ID, name, multilingual name, and enabled status |
|
|
440
|
+
|
|
441
|
+
## Business domain: corehrV1
|
|
442
|
+
| MCP Tool Name | API | Description |
|
|
443
|
+
| --- | --- | --- |
|
|
444
|
+
| corehr.v1.assignedUser.search | [List organization class role authorizations](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/assigned_user/search) | Query authorization information for organizational roles |
|
|
445
|
+
| corehr.v1.authorization.addRoleAssign | [Authorized roles managed by organizational structure.](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/add_role_assign) | Authorize roles and management scope for users. Continuing to authorize users who have been authorized for a certain role will add data scope on the basis of the original authorized data scope |
|
|
446
|
+
| corehr.v1.authorization.getByParam | [Query individual user authorization](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/get_by_param) | Query individual user authorization |
|
|
447
|
+
| corehr.v1.authorization.query | [Batch query user authorization](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/query) | Batch query the authorization information of a single user in the "Permission Settings" in Feishu's personnel management backend. You can find the corresponding location by following "Feishu Personnel" - "Permission Settings". Authorization information includes employee ID, authorized roles and other information |
|
|
448
|
+
| corehr.v1.authorization.removeRoleAssign | [Remove the user's authorized role](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/remove_role_assign) | Remove the specified role and authorization scope for which the user is authorized. Existing authorization can be obtained by querying [the authorization of a single user].Or view it in the Feishu [personnel management backend] |
|
|
449
|
+
| corehr.v1.authorization.updateRoleAssign | [更新组织类角色授权范围](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/update_role_assign) | Update the administrative scope of the role authorizationThe updated data range is subject to the data range submitted this time, and the unsubmitted part will be removed |
|
|
450
|
+
| corehr.v1.commonDataId.convert | [ID Convert](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-id/convert) | This interface is used to perform various ID conversions in Feishu People, Feishu Contacts, and people admin (Only applied to CoreHR new link tenants) |
|
|
451
|
+
| corehr.v1.commonDataMetaData.addEnumOption | [Add enumeration value option](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-meta_data/add_enum_option) | Add field enumeration value option |
|
|
452
|
+
| corehr.v1.commonDataMetaData.editEnumOption | [Modify enumeration value options](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/common_data-meta_data/edit_enum_option) | Modify field enumeration value options |
|
|
453
|
+
| corehr.v1.company.create | [Create company](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/create) | Support for adding company information in a single interface, including company basic information, registered address information, work address information, etc |
|
|
454
|
+
| corehr.v1.company.delete | [Delete company](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/delete) | Delete company |
|
|
455
|
+
| corehr.v1.company.get | [Query a single company](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get) | Query individual companies by ID |
|
|
456
|
+
| corehr.v1.company.list | [Get company list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/list) | Page query company, you can page through the full amount of company data |
|
|
457
|
+
| corehr.v1.company.patch | [Update company](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/patch) | Update company information, including basic information, registered address, office address, etc |
|
|
458
|
+
| corehr.v1.compensationStandard.match | [Get employee salary standards](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/compensation_standard/match) | - Call this interface to get salary scale information that matches the employee- When requesting, you can optionally pass the employee's department ID, job level ID, sequence ID and other filter conditions to match the salary standard.- This interface will return all information of salary standards that employees can match, including salary standard table ID, salary level, salary bandwidth, salary standard value, etc |
|
|
459
|
+
| corehr.v1.contract.create | [Create contract](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/create) | Create an employee contract directly through this interface |
|
|
460
|
+
| corehr.v1.contract.delete | [Delete contract](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/delete) | Delete the contract data directly through this interface. It cannot be queried after deletion. Please operate with caution |
|
|
461
|
+
| corehr.v1.contract.get | [Query a single contract](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/get) | This interface is used to query the details of a single contract based on the contract ID |
|
|
462
|
+
| corehr.v1.contract.list | [Get contract list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list) | Through this interface, you can query contract list information in batches. Currently, other filtering conditions are not supported, and a single query supports up to 50 pieces of data |
|
|
463
|
+
| corehr.v1.contract.patch | [Update contract](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/patch) | Information related to employee contracts can be updated through this interface, and parameters that have not been modified will retain their original values |
|
|
464
|
+
| corehr.v1.countryRegion.get | [Search a single country/region information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/get) | Search a single country/region information |
|
|
465
|
+
| corehr.v1.countryRegion.list | [Query country/region information in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/country_region/list) | Query country/region information in batches |
|
|
466
|
+
| corehr.v1.currency.get | [Query single currency information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/get) | Query single currency information |
|
|
467
|
+
| corehr.v1.currency.list | [Query currency information in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/currency/list) | Query currency information in batches |
|
|
468
|
+
| corehr.v1.customField.getByParam | [Get field details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param) | Get the details of a field under a specific "Feishu Personnel" object. Both system standard and user defined fields are supported. Could be used to get e.g. the enum option list in an enum field, the custom field list in a lookup field, and so on. Please refer to the operation manual ["How to operate custom fields through OpenAPI] for more details |
|
|
469
|
+
| corehr.v1.customField.listObjectApiName | [Get a list of Feishu personnel objects](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/list_object_api_name) | Get a list of objects in "Feishu Personnel", including system preset objects and custom objects |
|
|
470
|
+
| corehr.v1.customField.query | [Get a list of custom fields](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query) | Get the list of custom fields under specified "Feishu Personnel" objects. Please refer to the operation manual ["How to operate custom fields through OpenAPI] for more details |
|
|
471
|
+
| corehr.v1.department.create | [Create department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/create) | Support department information addition in a single interface, including department basic information, department head, department custom field information, etc |
|
|
472
|
+
| corehr.v1.department.delete | [Delete department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/delete) | You can delete a department record by department ID through this interface |
|
|
473
|
+
| corehr.v1.department.get | [Get department information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get) | The interface supports batch query of department details of the day by department id, including name, description, enable status, etc |
|
|
474
|
+
| corehr.v1.department.list | [Get department list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/list) | Query department information in batches, including department basic information, custom field information, etc |
|
|
475
|
+
| corehr.v1.department.patch | [Update department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/patch) | Update department information, including basic information and custom field information |
|
|
476
|
+
| corehr.v1.employeeType.create | [Creator employee type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/create) | Creator employee type |
|
|
477
|
+
| corehr.v1.employeeType.delete | [Delete employee type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/delete) | Delete employee type. After deletion, the query interface cannot obtain the deleted data |
|
|
478
|
+
| corehr.v1.employeeType.get | [Query an individual employee type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get) | Obtain workforce type information with ID |
|
|
479
|
+
| corehr.v1.employeeType.list | [Batch query for employee types](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/list) | Batch query for employee types |
|
|
480
|
+
| corehr.v1.employeeType.patch | [Update employee type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/patch) | Update employee type |
|
|
481
|
+
| corehr.v1.employment.create | [Create employment information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/create) | Creator's employment information |
|
|
482
|
+
| corehr.v1.employment.delete | [Delete employment information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/delete) | Delete employment information of personnel |
|
|
483
|
+
| corehr.v1.employment.patch | [Update employment information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employment/patch) | Update employment information |
|
|
484
|
+
| corehr.v1.jobChange.create | [Initiate employee changes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/create) | This interface is used to initiate an employee change. If the initiation is successful, an employee's change data will be generated and corresponding events will be generated at the same time. Refer to [Change of Change Status] |
|
|
485
|
+
| corehr.v1.jobData.create | [Create job information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/create) | Create job data |
|
|
486
|
+
| corehr.v1.jobData.delete | [Delete job information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/delete) | Delete job information |
|
|
487
|
+
| corehr.v1.jobData.get | [Get job information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/get) | Obtain employee job information with ID |
|
|
488
|
+
| corehr.v1.jobData.list | [Get the list of job information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/list) | Get the list of job information |
|
|
489
|
+
| corehr.v1.jobData.patch | [Update job information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_data/patch) | Update job data |
|
|
490
|
+
| corehr.v1.jobFamily.create | [Create job sequence](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/create) | A single job faimly of information can be created through this API, and the API verifies the content of request |
|
|
491
|
+
| corehr.v1.jobFamily.delete | [Delete job sequence](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/delete) | The interface supports deleting single Job family information by Job family ID |
|
|
492
|
+
| corehr.v1.jobFamily.get | [Query a single job sequence](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get) | The API supports querying single Job faimly details by Job faimly ID |
|
|
493
|
+
| corehr.v1.jobFamily.list | [Get the list of job sequence](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/list) | The API supports obtaining all Job family information under the tenant. When there are too many job family, you can call the interface multiple times to obtain all job family details, including job family code, name, etc |
|
|
494
|
+
| corehr.v1.jobFamily.patch | [Update job sequence](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/patch) | Individual Job family details such as sequence name, parent sequence ID, etc. can be updated by sequence ID |
|
|
495
|
+
| corehr.v1.jobLevel.create | [Create job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/create) | Use the specified information to create job level information. Each call supports the creation of a job level object, and the relevant rules will be checked in the interface |
|
|
496
|
+
| corehr.v1.jobLevel.delete | [Delete job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/delete) | You can delete a rank object by rank ID through this OpenAPI |
|
|
497
|
+
| corehr.v1.jobLevel.get | [Get single job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get) | The interface supports querying the detailed information of a single job level by job level ID, including the name, description, enabled status, and so on |
|
|
498
|
+
| corehr.v1.jobLevel.list | [Get the list of job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/list) | The interface supports obtaining all rank information under the tenant. When there are too many ranks, you can call the interface repeatedly to obtain all rank details, including rank value, code, name, etc |
|
|
499
|
+
| corehr.v1.jobLevel.patch | [Update job level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/patch) | You can update individual rank information by Job level ID, including Job level values, names, and other information |
|
|
500
|
+
| corehr.v1.job.create | [Create job profile](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/create) | You can create new job information through this interface |
|
|
501
|
+
| corehr.v1.job.delete | [Delete job profile](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/delete) | Delete job profile |
|
|
502
|
+
| corehr.v1.job.get | [Get job profile](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get) | The interface supports batch query of job details of the day by job id, including name, description, enabling status and so on |
|
|
503
|
+
| corehr.v1.job.list | [Get the list of job profile](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/list) | Get the list of job profile |
|
|
504
|
+
| corehr.v1.job.patch | [Update Job](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/patch) | You can update a job through this interface |
|
|
505
|
+
| corehr.v1.leaveGrantingRecord.create | [Create vacation grant records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave_granting_record/create) | Write the leave issuance record to the Feishu personnel leave system. Corresponding to the creation or import function of leave management - leave management - [issuance record] |
|
|
506
|
+
| corehr.v1.leaveGrantingRecord.delete | [Delete vacation grant records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave_granting_record/delete) | Delete the issuance records in the Feishu personnel leave system, Leave Management - Leave Management - [Issuance Records] (only supports deleting records where the source of issuance is "manual issuance" or "external system issuance") |
|
|
507
|
+
| corehr.v1.leave.calendarByScope | [query calendar by scope](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/calendar_by_scope) | Get the work calendar id according to the scope of the calendar.The scope of application includes work location, working hours system, etc |
|
|
508
|
+
| corehr.v1.leave.leaveBalances | [Batch check employee vacation balance](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_balances) | Get the balance data of each vacation of employees in batches. The corresponding page is Leave Management - Leave Management - [Leave Report] |
|
|
509
|
+
| corehr.v1.leave.leaveRequestHistory | [Batch query employee leave records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_request_history) | Get the leave record data of employees in batches. The corresponding page is Leave Management - Leave Management - [Leave Record] |
|
|
510
|
+
| corehr.v1.leave.leaveTypes | [Get a list of vacation types](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/leave_types) | Get a list of vacation types configured in the background of vacation settings (such as annual leave, personal leave, marriage leave, etc.). The function of the corresponding page is Settings - Vacation Settings - [Vacation Types] |
|
|
511
|
+
| corehr.v1.leave.workCalendar | [Get work calendar](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar) | Get work calendar information, such as name, status, etc |
|
|
512
|
+
| corehr.v1.leave.workCalendarDate | [Get work calendar date](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/leave/work_calendar_date) | Get work calendar date,the details for each day in the work calendar, such as date, date type, etc |
|
|
513
|
+
| corehr.v1.location.create | [Create location](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/create) | Create location data for the first time in the system |
|
|
514
|
+
| corehr.v1.location.delete | [Delete location](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/delete) | Delete location |
|
|
515
|
+
| corehr.v1.location.get | [Get location information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get) | The interface is used to query location information according to location ID, including location name, description, location usage, working hours system, regional setting, time zone and associated address information |
|
|
516
|
+
| corehr.v1.location.list | [Get location list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/list) | The interface is used to query location information in batches according to location ID, including location name, description, location purpose, working hours system, regional setting, time zone and associated address information |
|
|
517
|
+
| corehr.v1.nationalIdType.create | [Create national document type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/create) | Create national document type |
|
|
518
|
+
| corehr.v1.nationalIdType.delete | [Delete national document type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/delete) | Delete national document type |
|
|
519
|
+
| corehr.v1.nationalIdType.get | [Get national ID type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/get) | Obtain national ID type information with ID |
|
|
520
|
+
| corehr.v1.nationalIdType.list | [Get the list of national ID type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/list) | Get the list of national ID type |
|
|
521
|
+
| corehr.v1.nationalIdType.patch | [Update national document type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/national_id_type/patch) | Update national document type |
|
|
522
|
+
| corehr.v1.offboarding.query | [Query the list of reasons for employees offboarding](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/query) | This interface is used to query the option information of [Offboarding configuration] > reason for offboarding, which return the unique identity, name and enabled status of the reason for offboarding option |
|
|
523
|
+
| corehr.v1.offboarding.search | [search offboarding information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/search) | This interface supports searching for offboarding information in fields such as employee ID, resignation approval start time, and resignation date, which can obtain information including resignation date, reason for resignation, resignation status, and process approval status |
|
|
524
|
+
| corehr.v1.offboarding.submit | [Operation employee resignation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/offboarding/submit) | This interface is used to initiate employee offboarding, which is equivalent to the direct offboarding function of employees in the Feishu CoreHR. If initiated successfully, an employee's offboarding record will be saved and corresponding events will be send.Refer to [Change of offboarding application status (new)] and [Change of offboarding checklist status] |
|
|
525
|
+
| corehr.v1.person.create | [Create Personal Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/create) | Create personal information |
|
|
526
|
+
| corehr.v1.person.delete | [Delete personal information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/delete) | Delete personal information |
|
|
527
|
+
| corehr.v1.person.get | [Get personal information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/get) | Obtain personal information with ID |
|
|
528
|
+
| corehr.v1.person.patch | [Update personal information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/person/patch) | Update personal information |
|
|
529
|
+
| corehr.v1.preHire.delete | [Delete pending staff](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/delete) | Delete pending staff |
|
|
530
|
+
| corehr.v1.preHire.get | [Query individual candidates](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/get) | Query a single candidate by ID |
|
|
531
|
+
| corehr.v1.preHire.list | [Batch query for candidates](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/list) | Batch query for candidates |
|
|
532
|
+
| corehr.v1.preHire.patch | [Update pending entry information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/patch) | Update pending entry information |
|
|
533
|
+
| corehr.v1.processFormVariableData.get | [Get process form data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/process-form_variable_data/get) | Get process form data, including business and custom fields in the form, based on the process instance id (process_id). Only support CoreHR and Attendance business processes for Feishu |
|
|
534
|
+
| corehr.v1.securityGroup.list | [Get a list of roles in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/list) | Batch query the role list in "Role Settings" in Feishu's personnel management backend. You can find the corresponding location by following "Feishu Personnel" - "Permission Settings" - "Role Settings". The role list contains information such as the role's ID, role name, and description |
|
|
535
|
+
| corehr.v1.securityGroup.query | [Query HRBP/territory BP](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/security_group/query) | Get HRBP/location BP by department or work location |
|
|
536
|
+
| corehr.v1.subdivision.get | [Query a single province/administrative region information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/get) | Query single province/administrative region information |
|
|
537
|
+
| corehr.v1.subdivision.list | [Query province/administrative region information in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subdivision/list) | Query province/administrative region information in batches |
|
|
538
|
+
| corehr.v1.subregion.get | [Query single city/region information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/get) | Query single city/region information |
|
|
539
|
+
| corehr.v1.subregion.list | [Query city/region information in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/subregion/list) | Query city/region information in batches |
|
|
540
|
+
| corehr.v1.transferReason.query | [Get a list of reasons for the change](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_reason/query) | Get a list of reasons for the change |
|
|
541
|
+
| corehr.v1.transferType.query | [Get a list of change types](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/transfer_type/query) | Get a list of change types |
|
|
542
|
+
| corehr.v1.workingHoursType.create | [Create working hours type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/create) | Creation of a working hour system |
|
|
543
|
+
| corehr.v1.workingHoursType.delete | [Delete working hours type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/delete) | Delete working hours system |
|
|
544
|
+
| corehr.v1.workingHoursType.get | [Query individual working hours type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get) | Obtain working hours information with ID |
|
|
545
|
+
| corehr.v1.workingHoursType.list | [Get the list of working hours](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/list) | Get the list of working hours |
|
|
546
|
+
| corehr.v1.workingHoursType.patch | [Update working hours type](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/patch) | Update the working hours system |
|
|
547
|
+
|
|
548
|
+
## Business domain: corehrV2
|
|
549
|
+
| MCP Tool Name | API | Description |
|
|
550
|
+
| --- | --- | --- |
|
|
551
|
+
| corehr.v2.approvalGroups.get | [Query organization adjustment records by process ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approval_groups/get) | Query organization adjustment records by process ID |
|
|
552
|
+
| corehr.v2.approvalGroups.openQueryDepartmentChangeListByIds | [Batch query department change records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approval_groups/open_query_department_change_list_by_ids) | Batch query department adjustment content based on department adjustment record ID, such as department adjustment type, department name before and after adjustment, role information before and after department adjustment, etc |
|
|
553
|
+
| corehr.v2.approvalGroups.openQueryJobChangeListByIds | [Batch query job change records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approval_groups/open_query_job_change_list_by_ids) | Batch query job change records by job change record ID |
|
|
554
|
+
| corehr.v2.approver.list | [Get specified employment process approver list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/approver/list) | Approval tasks depend on the existence of process node instances, each process node instance may contain one or more approval tasks, each task indicates who the current node's approver is, and the interface can obtain the approval task list of the specified member(This function is not controlled by the scope of data permissions) |
|
|
555
|
+
| corehr.v2.basicInfoBankBranch.search | [Search bank branch information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank_branch/search) | Search bank branch information, by bank ID, bank branch ID, bank branch's exact name, bank code, bank status or update time |
|
|
556
|
+
| corehr.v2.basicInfoBank.search | [Search bank information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-bank/search) | Search bank information by its ID or exact name |
|
|
557
|
+
| corehr.v2.basicInfoCity.search | [Search city information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-city/search) | Search city information, by city ID or principal subdivision (province) ID |
|
|
558
|
+
| corehr.v2.basicInfoCountryRegionSubdivision.search | [Search principal subdivision (province) information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region_subdivision/search) | Search principal subdivision (province) information by country/region ID, principal subdivision ID, or status |
|
|
559
|
+
| corehr.v2.basicInfoCountryRegion.search | [Search country/region information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search) | Search country/region information according to country/region ID and status |
|
|
560
|
+
| corehr.v2.basicInfoCurrency.search | [Search currency information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-currency/search) | Search currency information according to currency ID and status |
|
|
561
|
+
| corehr.v2.basicInfoDistrict.search | [Search area/county information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-district/search) | Search district/county information, by district/county ID or city ID |
|
|
562
|
+
| corehr.v2.basicInfoLanguage.search | [Query language information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-language/search) | Query language information in batches according to language ID and status |
|
|
563
|
+
| corehr.v2.basicInfoNationality.search | [Search nationality information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-nationality/search) | Search nationality information according to country ID and nationality ID |
|
|
564
|
+
| corehr.v2.basicInfoTimeZone.search | [Query time zone information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-time_zone/search) | Query time zone information in batches according to time zone ID and status |
|
|
565
|
+
| corehr.v2.bp.getByDepartment | [Batch Get Department HRBP](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/get_by_department) | Get departmen HRBP information, including HRBPs from superior departments |
|
|
566
|
+
| corehr.v2.bp.list | [Get HRBP List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/bp/list) | Get a list of HRBPs. The list contains HRBP ID and department ID information |
|
|
567
|
+
| corehr.v2.company.active | [Enable/Disable Company](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/active) | Enabling or deactivating a company |
|
|
568
|
+
| corehr.v2.company.batchGet | [Batch get company information by ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/batch_get) | Query company information in batches by ID |
|
|
569
|
+
| corehr.v2.company.queryRecentChange | [Query information-changed companies](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/company/query_recent_change) | Query the companies whose current effective information has changed within the specified time range, that is, only when the effective time of the current effective version of the company is within the query time range, will the company ID be returned |
|
|
570
|
+
| corehr.v2.contract.search | [Search Contract](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/contract/search) | This interface can be used to search for contract information, including contract start time, contract expected end time, contract actual end time, contract company entity, etc |
|
|
571
|
+
| corehr.v2.costAllocation.batchQuery | [Query cost allocation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_allocation/batch_query) | query cost allocation |
|
|
572
|
+
| corehr.v2.costAllocation.createVersion | [Create cost allocation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_allocation/create_version) | Create cost allocation |
|
|
573
|
+
| corehr.v2.costAllocation.removeVersion | [Delete cost allocation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_allocation/remove_version) | Delete cost allocation |
|
|
574
|
+
| corehr.v2.costAllocation.updateVersion | [Update cost allocation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_allocation/update_version) | Update cost allocation |
|
|
575
|
+
| corehr.v2.costCenter.create | [create cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/create) | Create a cost center; you can define the name of the cost center, the parent cost center, the person in charge of the cost center, the effective time, etc |
|
|
576
|
+
| corehr.v2.costCenter.delete | [delete cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/delete) | Delete cost center records |
|
|
577
|
+
| corehr.v2.costCenter.patch | [enable or disable cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/patch) | Enable and deactivate the cost center to support a single operation |
|
|
578
|
+
| corehr.v2.costCenter.queryRecentChange | [query recent change cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/query_recent_change) | Query the cost center whose current effective information has changed within the specified time range, that is, only when the effective time of the current effective version of the cost center is within the query time range, the cost center ID will be returned |
|
|
579
|
+
| corehr.v2.costCenter.search | [search cost center version](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search) | Search cost center information; support cost center ID, cost center name, cost center code, cost center superior search cost center information, with paging function |
|
|
580
|
+
| corehr.v2.costCenterVersion.create | [create version of cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/create) | Create the cost center version; you can define the name, description, superior cost, cost center person in charge, version effective time and other information of the cost center |
|
|
581
|
+
| corehr.v2.costCenterVersion.delete | [delete version of cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/delete) | The interface supports revocation of cost center version information through the Version ID of the cost center |
|
|
582
|
+
| corehr.v2.costCenterVersion.patch | [update version of cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center-version/patch) | Correct the version record of the cost center. The fields that can be corrected include: name, superior cost center, list of cost center leaders, description of the cost center, and effective time |
|
|
583
|
+
| corehr.v2.customOrg.active | [Enable / disable custom organization](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/custom_org/active) | Enable or disable custom organizations |
|
|
584
|
+
| corehr.v2.customOrg.create | [Create Custom Organization](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/custom_org/create) | Create a custom organization using the specified information, and the relevant rules will be checked in the interface |
|
|
585
|
+
| corehr.v2.customOrg.deleteOrg | [Delete custom organization](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/custom_org/delete_org) | Delete the corresponding custom organization based on the incoming custom organization ID |
|
|
586
|
+
| corehr.v2.customOrg.patch | [Update Custom Organization Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/custom_org/patch) | Update the basic information of a custom organization. Updating automatic matching rules is not supported. If you need to update automatic matching rules, please use [Update Matching Rules] |
|
|
587
|
+
| corehr.v2.customOrg.query | [Get custom organization information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/custom_org/query) | Query custom organization information in bulk based on the passed filter criteria. Without passing any filter criteria, all custom organization data under this tenant is obtained by default |
|
|
588
|
+
| corehr.v2.customOrg.updateRule | [Update matching rules for custom organization](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/custom_org/update_rule) | Update the matching rules for custom organizations. Only custom organization types with "Set up automatic matching rules for organizations" turned on are available. To update the basic information of a custom organization, use [Update Custom Organization] |
|
|
589
|
+
| corehr.v2.defaultCostCenter.batchQuery | [Batch query default cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/default_cost_center/batch_query) | Query default cost center |
|
|
590
|
+
| corehr.v2.defaultCostCenter.createVersion | [Create default cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/default_cost_center/create_version) | Create default cost center |
|
|
591
|
+
| corehr.v2.defaultCostCenter.removeVersion | [Delete default cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/default_cost_center/remove_version) | Delete default cost center |
|
|
592
|
+
| corehr.v2.defaultCostCenter.updateVersion | [Update default cost center](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/default_cost_center/update_version) | Update default cost center |
|
|
593
|
+
| corehr.v2.department.batchGet | [Get department list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get) | Batch query department information.Compared with the historical version of the ["Get department list" ] API, the V2 version has added sensitive field permission requirements and uses POST HTTP requests |
|
|
594
|
+
| corehr.v2.department.delete | [Delete department V2](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/delete) | Delete department V2 |
|
|
595
|
+
| corehr.v2.department.parents | [Get Parent Department Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/parents) | This interface is used to recursively obtain the parent department information of the department, and return the list of authorized parent department information in the order from child to parent |
|
|
596
|
+
| corehr.v2.department.patch | [Update department V2](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/patch) | Update department V2 to increase data line authority |
|
|
597
|
+
| corehr.v2.department.queryMultiTimeline | [Batch query department version information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_multi_timeline) | According to the department ID list, batch query all department version information within the start and end time, including department name, department type, superior, code, person in charge, whether it is enabled, description and other information |
|
|
598
|
+
| corehr.v2.department.queryOperationLogs | [query department operation logs](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_operation_logs) | Batch query department operation logs within a specified time range |
|
|
599
|
+
| corehr.v2.department.queryRecentChange | [Query information-changed departments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_recent_change) | Query the departments whose current effective information has changed within the specified time range, that is, only when the effective time of the current effective version of the department is within the query time range, the department ID will be returned |
|
|
600
|
+
| corehr.v2.department.queryTimeline | [Get department information on a specified date](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/query_timeline) | Query the basic information of the designated effective department, including department name, department type, superior, code, person in charge, whether it is enabled, description and other information |
|
|
601
|
+
| corehr.v2.department.search | [Search department information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search) | The interface supports batch search for department details of the day by department ID, superior department ID, department head, name, and coding fields, including the name, description, and enabling status of the department |
|
|
602
|
+
| corehr.v2.department.tree | [Get the department architecture tree on any date](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/tree) | Support passing in department ID (default root department), any date (default current date). Breadth traversal from a given department ID, returning up to 2000 rows of data per page |
|
|
603
|
+
| corehr.v2.employee.batchGet | [Batch access to employee information through employee ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get) | Batch access to employee information through employee ID |
|
|
604
|
+
| corehr.v2.employee.create | [Add individual](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/create) | Support for adding all personnel information in a single interface, including basic personnel information, employment information, job records, and other grouping information |
|
|
605
|
+
| corehr.v2.employee.search | [search employee information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search) | Search for employee information |
|
|
606
|
+
| corehr.v2.employeesAdditionalJob.batch | [Batch querying additional jobs](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/batch) | Query the additional job information of employees in batches |
|
|
607
|
+
| corehr.v2.employeesAdditionalJob.create | [Create Additional Job](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/create) | Create additional job for employees |
|
|
608
|
+
| corehr.v2.employeesAdditionalJob.delete | [Delete Additional Job](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/delete) | Delete a designated employee additional job |
|
|
609
|
+
| corehr.v2.employeesAdditionalJob.patch | [Update Additional Job](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-additional_job/patch) | Update employees' additional jobs |
|
|
610
|
+
| corehr.v2.employeesBp.batchGet | [Batch Get Employee BP/Location BP Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-bp/batch_get) | Get employee's HRBP and Location BP, including HRBP and Location BP from superior department |
|
|
611
|
+
| corehr.v2.employeesInternationalAssignment.create | [Create International Assignment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-international_assignment/create) | Create assignment information |
|
|
612
|
+
| corehr.v2.employeesInternationalAssignment.delete | [Delete International Assignment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-international_assignment/delete) | Delete a certain overseas assignment information |
|
|
613
|
+
| corehr.v2.employeesInternationalAssignment.list | [Query International Assignment Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-international_assignment/list) | Query Employee‘s International Assignment Information |
|
|
614
|
+
| corehr.v2.employeesInternationalAssignment.patch | [Patch Employees Assignment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-international_assignment/patch) | - The departmental job mode will affect the mandatory verification of fields such as position and job title- The fields related to overseas assignment information will be verified as mandatory based on the 'Feishu Personnel - Personnel Profile Configuration' |
|
|
615
|
+
| corehr.v2.employeesJobData.batchGet | [Batch Get Employee JobData](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/batch_get) | Batch get job data through employee employment ID |
|
|
616
|
+
| corehr.v2.employeesJobData.query | [Get Employee JobData List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employees-job_data/query) | Get a list of job data |
|
|
617
|
+
| corehr.v2.enum.search | [Query enums](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/enum/search) | Query the enumeration details based on the enumeration's APIName for scenarios like BPM |
|
|
618
|
+
| corehr.v2.jobChange.create | [Job Change](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/create) | This interface is used to initiate an employee change. If the initiation is successful, an employee's change data will be generated |
|
|
619
|
+
| corehr.v2.jobChange.revoke | [Revoke job change](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/revoke) | The interface is used to revoke employee changes. If initiated successfully, it will revoke a change request that has been submitted, is pending, or has already taken effect, while generating the corresponding event:[Transaction state change]. An operator must be specified when using it, and must have permissions of the job change process or must be the approvor of the process |
|
|
620
|
+
| corehr.v2.jobChange.search | [Search job_change information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/search) | Search for movement information |
|
|
621
|
+
| corehr.v2.jobFamily.batchGet | [Get job family information in batches according to conditions](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_family/batch_get) | Batch query the detailed information of the currently effective version of the job family through the sequence ID or sequence Code, including the sequence name, activation status, parent sequence, etc |
|
|
622
|
+
| corehr.v2.jobGrade.create | [Create JobGrade](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/create) | create job grade |
|
|
623
|
+
| corehr.v2.jobGrade.delete | [Delete JobGrade](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/delete) | delete job grade |
|
|
624
|
+
| corehr.v2.jobGrade.patch | [Patch JobGrade](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/patch) | update job grade |
|
|
625
|
+
| corehr.v2.jobGrade.query | [Get the job grade](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_grade/query) | query job grade |
|
|
626
|
+
| corehr.v2.jobLevel.batchGet | [Get job level information in batches according to conditions](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_level/batch_get) | This interface supports batch query of job level details by job level ID or job level Code, including the name, description, and activation status |
|
|
627
|
+
| corehr.v2.job.get | [Get job profile (V2)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/get) | Obtain job profile with ID |
|
|
628
|
+
| corehr.v2.job.list | [Get the list of job profile](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/list) | Get the list of job profile |
|
|
629
|
+
| corehr.v2.job.queryRecentChange | [query recent change job](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job/query_recent_change) | Query the job where the current effective information has changed within the specified time range, that is, only the effective time of the current effective version of the job is within the query time range will the job id be returned |
|
|
630
|
+
| corehr.v2.location.active | [Enable/Disable Location](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/active) | Enable/Disable Location |
|
|
631
|
+
| corehr.v2.locationAddress.create | [Add Location Address](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/create) | Add Location Address |
|
|
632
|
+
| corehr.v2.locationAddress.delete | [Delete Location Address](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/delete) | Delete Location Address |
|
|
633
|
+
| corehr.v2.locationAddress.patch | [Update Location Address](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location-address/patch) | Update Location Address |
|
|
634
|
+
| corehr.v2.location.batchGet | [Batch get location information by ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/batch_get) | Feishu People(Enterprise Edition)-Organization management-Location-Batch get location information by ID-Batch get location information by location ID list |
|
|
635
|
+
| corehr.v2.location.patch | [Update Location](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/patch) | Update location |
|
|
636
|
+
| corehr.v2.location.queryRecentChange | [query recent change location](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/location/query_recent_change) | Query the cost center whose current effective information has changed within the specified time range, that is, only when the effective time of the current effective version of the cost center is within the query time range, the department ID will be returned |
|
|
637
|
+
| corehr.v2.offboarding.edit | [Edit offboarding info](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/edit) | This interface is used to edit Feishu CoreHR's [Offboarding information]. Supported fields include offboarding date, offboarding reason, offboarding initiation time, and offboarding approval time, etc. It also supports editing custom fields of offboarding (except attachment fields). When the interface is successfully submitted, the corresponding [offboarding information change] event will be generated |
|
|
638
|
+
| corehr.v2.offboarding.revoke | [Revoke offboarding](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/revoke) | Revoke the [offboarding information] of Feishu personnel through the offboarding ID. When the interface is successfully submitted, the corresponding [exit information change] event will be generated |
|
|
639
|
+
| corehr.v2.offboarding.submitV2 | [Submit offboarding](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/offboarding/submit_v2) | This interface is used to submit the [offboarding information] of Feishu Personnel. It supports filling in the offboarding date, reason for offboarding, block list and custom fields (except attachment fields). When the interface is successfully submitted, the corresponding [offboarding information change] event will be generated |
|
|
640
|
+
| corehr.v2.person.create | [Create person information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/create) | Create personal information |
|
|
641
|
+
| corehr.v2.person.patch | [update person information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/patch) | Update personal information |
|
|
642
|
+
| corehr.v2.preHire.complete | [Hire employee](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/complete) | Operate the employees to be hired to complete the induction, and officially enter the job to establish an employment relationship |
|
|
643
|
+
| corehr.v2.preHire.create | [Create pending staff](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/create) | Create pending staff |
|
|
644
|
+
| corehr.v2.preHire.delete | [delete prehire (recommend)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/delete) | Deleting employees who are not yet hired, once deleted, their information cannot be searched. Please proceed with caution |
|
|
645
|
+
| corehr.v2.preHire.patch | [update prehire (recommend)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/patch) | update the value of prehire object |
|
|
646
|
+
| corehr.v2.preHire.query | [query prehire](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query) | The interface is used to query the information of the personnel to be hired according to the ID of the personnel to be hired (support batch), including personal information such as name, mobile phone number and job information.- Delay description: The delay of the database leader/follower is within 2s, that is, the data may not be queried by calling this interface within 2s after directly creating the job.- Performance description: This interface returns a lot of data. Please control the number of batches (< 10) and appropriately reduce the number of query fields (< 50) when querying |
|
|
647
|
+
| corehr.v2.preHire.restoreFlowInstance | [restore flow instance](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/restore_flow_instance) | Perform the resume onboarding operation on the designated cancelled pending prehire through this interface, and correspond to the resume onboarding button on the onboarding management page |
|
|
648
|
+
| corehr.v2.preHire.search | [Search Pre Hire](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/search) | Search for pre hire information |
|
|
649
|
+
| corehr.v2.preHire.transitTask | [Transit task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/transit_task) | Configuring the onboarding process, tasks in progress can be filled in locally through this api |
|
|
650
|
+
| corehr.v2.preHire.withdrawOnboarding | [withdraw onboarding](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/withdraw_onboarding) | Through this interface, perform the withdraw onboarding operation on the designated prehire who are ready for onboarding, and correspond to the withdraw onboarding button on the onboarding management page |
|
|
651
|
+
| corehr.v2.processRevoke.update | [Revoke process](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process_revoke/update) | Revoke a single process, the status is that the completed process can be revoked, and an operator needs to be designated when using it. Currently, process administrators and document administrators are supported |
|
|
652
|
+
| corehr.v2.processWithdraw.update | [Withdraw process](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process_withdraw/update) | Rollback a single approval instance in the "Under review" status. The approval process ends after rollback |
|
|
653
|
+
| corehr.v2.processApprover.update | [Approve / Reject approver](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-approver/update) | Approve or Reject approval task. For individual approval, if one approval task is approved, the entire node is approved; For countersign approval, if all approval tasks are approved, the node will be approved. if there are mandatory fields in the form, it is supported to submit the value of form fields |
|
|
654
|
+
| corehr.v2.processExtra.update | [Extra approver](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-extra/update) | There are three ways to extra a node or approver in a single process: pre-extra, current-extra and post-extra |
|
|
655
|
+
| corehr.v2.processFormVariableData.get | [Get process form data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-form_variable_data/get) | Get process form data, including business and custom fields in the form, based on the process instance id (process_id). Only support CoreHR and Attendance business processes for Feishu.Note: The old version of the API document has been moved to the [Historical Version] directory |
|
|
656
|
+
| corehr.v2.process.get | [Get process detail](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/get) | Get process detail by process_id(This function is not controlled by the scope of data permissions). For example, process status, process initiator, process initiation time, process summary, all pending, done, and CC tasks in the process |
|
|
657
|
+
| corehr.v2.process.list | [Query the list of process instance](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process/list) | Query the list of process instances(This function is not controlled by the scope of data permissions).Process Instance: It refers to the specific process initiated by the user in the business function or the Feishu HR approval center. The process_id is its unique identifier.Process Definition: It refers to the process configured by the administrator on the settings side, similar to a process template. The flow_definition_id is its unique identifier. The process initiated by the user is generated according to the configuration of the corresponding process definition |
|
|
658
|
+
| corehr.v2.processTransfer.update | [Transfer approver](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/process-transfer/update) | Transfers a single approval task. After that, the approval process will be transferred to the transfer recipient |
|
|
659
|
+
| corehr.v2.reportDetailRow.batchDelete | [batch delete report detail row](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/report_detail_row/batchDelete) | After deleting the reporting lines in batches, you can view it in [Settings - Compilation Planning Settings - Compilation Planning XXX - Centralized Filling - View Data] |
|
|
660
|
+
| corehr.v2.reportDetailRow.batchSave | [batch create and update report detail row](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/report_detail_row/batchSave) | After creating/updating the reporting line in batches, you can view it in [Settings - Compilation Planning Settings - Compilation Planning XXX - Centralized Filling - View Data] |
|
|
661
|
+
| corehr.v2.workforcePlanDetailRow.batchDelete | [batch delete workforce plan detail row](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail_row/batchDelete) | After deleting the detailed rows in batches, you can check whether the detailed rows are deleted in [Settings - Planning Settings - Planning XXX - Editing Data] |
|
|
662
|
+
| corehr.v2.workforcePlanDetailRow.batchSave | [batch create and update workforce plan detail row](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail_row/batchSave) | After creating/updating detailed rows in batches, you can view them in [Settings - Planning Settings - Planning XXX - Editing Data] |
|
|
663
|
+
| corehr.v2.workforcePlanDetail.batch | [Query workforce plan details (not supports custom organization)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail/batch) | Query the workforce plan detail, including dimension information, workforce plan and estimated number of employees |
|
|
664
|
+
| corehr.v2.workforcePlanDetail.batchV2 | [Query workforce plan details (supports custom organization)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan_detail/batch_v2) | Feishu People(Enterprise Edition)-Workforce_plan-Query workforce plan details (supports custom organization)-Query the workforce plan detail, including dimension information, workforce plan, estimated number of employees, incumbency, active individuals and pre-increase/decrease numbers |
|
|
665
|
+
| corehr.v2.workforcePlan.list | [Query workforce plan](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/workforce_plan/list) | Get a list of workforce plan based on incoming filters |
|
|
666
|
+
|
|
667
|
+
## Business domain: directoryV1
|
|
668
|
+
| MCP Tool Name | API | Description |
|
|
669
|
+
| --- | --- | --- |
|
|
670
|
+
| directory.v1.collaborationRule.create | [Add collaboration rules](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/collaboration_rule/create) | Admin perspective Added collaboration rules. Users need to have trusted party administrator role |
|
|
671
|
+
| directory.v1.collaborationRule.delete | [Delete the collaboration rules](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/collaboration_rule/delete) | Administrator delete collaboration rules. Users need to have trusted party administrator role |
|
|
672
|
+
| directory.v1.collaborationRule.list | [Query the collaboration rules](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/collaboration_rule/list) | Administrator query collaboration rules. Users need to have trusted party administrator role |
|
|
673
|
+
| directory.v1.collaborationRule.update | [Modify the collaboration rules](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/collaboration_rule/update) | Administrator updates the collaboration rules. Users need to have trusted party administrator role |
|
|
674
|
+
| directory.v1.collaborationTenant.list | [Query the list of trusted parties by Admin](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/collaboration_tenant/list) | When creating a rule, you need to know the tenant key of the other tenant, and you can get a valid tenant key through this interface. Please use the trusted party administrator role to use this function |
|
|
675
|
+
| directory.v1.collborationShareEntity.list | [Query the sharing members between the trust party relations](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/collboration_share_entity/list) | When creating a rule, you need to query the openIDs of this tenant and the other tenant entities, and these entities should be within the sharing scope of the trusted party. This interface can obtain the scope shared by the subject and object tenants of the trusted parties |
|
|
676
|
+
| directory.v1.department.create | [Create department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/create) | 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. |
|
|
677
|
+
| directory.v1.department.delete | [Delete department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/delete) | This interface is used to delete departments |
|
|
678
|
+
| directory.v1.department.filter | [List department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/filter) | This interface is used to obtain the list of eligible department details in batches according to the specified conditions |
|
|
679
|
+
| directory.v1.department.mget | [Batch get department info](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/mget) | This interface supports passing in multiple department IDs and returns detailed information for each department (such as name, person in charge, sub-departments, etc.). |
|
|
680
|
+
| directory.v1.department.patch | [Update department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/patch) | This interface is used to update department information. Only the parts param that are explicitly passed are updated |
|
|
681
|
+
| directory.v1.department.search | [Search department](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/search) | 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. |
|
|
682
|
+
| directory.v1.employee.create | [Create employee](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/create) | 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 Feishu enterprise, which is equivalent to the "User" in the address book OpenAPI. |
|
|
683
|
+
| directory.v1.employee.delete | [Delete employee](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/delete) | This interface is for resign employees |
|
|
684
|
+
| directory.v1.employee.filter | [Get employee list in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/filter) | This interface is used to obtain a batch list of eligible employee details according to the specified conditions.Employee refers to a member of Feishu's enterprise who is identified as "Employee", which is equivalent to "User" in the contact OpenAPI |
|
|
685
|
+
| directory.v1.employee.mget | [Obtain employee information in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/mget) | 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 Feishu's enterprise who is identified as "Employee", which is equivalent to "User" in the contact OpenAPI |
|
|
686
|
+
| directory.v1.employee.patch | [Update employee information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/patch) | 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 Feishu's enterprise who is identified as "Employee", which is equivalent to "User" in the address book OpenAPI |
|
|
687
|
+
| directory.v1.employee.regular | [Update pre-resigned members to un-resigned employees](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/regular) | 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 |
|
|
688
|
+
| directory.v1.employee.resurrect | [Reinstate departed employees](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/resurrect) | This interface is used to restore the members who have left the company and restore them to the working state. |
|
|
689
|
+
| directory.v1.employee.search | [Search employee](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/search) | 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 Feishu who is an "Employee", which is equivalent to a "User" in the Contacts OpenAPI |
|
|
690
|
+
| directory.v1.employee.toBeResigned | [Update un-resigned employees to be resigned](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/to_be_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 |
|
|
691
|
+
|
|
692
|
+
## Business domain: docsV1
|
|
693
|
+
| MCP Tool Name | API | Description |
|
|
694
|
+
| --- | --- | --- |
|
|
695
|
+
| docs.v1.content.get | [Get docs content](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/docs-v1/content/get) | You can obtain the docs content. Currently, only upgraded document content in markdown format is supported |
|
|
696
|
+
|
|
697
|
+
## Business domain: docxV1
|
|
698
|
+
| MCP Tool Name | API | Description |
|
|
699
|
+
| --- | --- | --- |
|
|
700
|
+
| docx.v1.chatAnnouncementBlock.batchUpdate | [Batch update blocks in group announcement](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/batch_update) | Group Chat-Upgraded Group announcement-Block-Batch update blocks in group announcement |
|
|
701
|
+
| docx.v1.chatAnnouncementBlockChildren.batchDelete | [Delete blocks in group announcement](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/batch_delete) | 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 |
|
|
702
|
+
| docx.v1.chatAnnouncementBlockChildren.create | [Create blocks in group announcement](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/create) | Group Chat-Upgraded Group announcement-Block-Create blocks in group announcement |
|
|
703
|
+
| docx.v1.chatAnnouncementBlockChildren.get | [Obtain all the child blocks](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/get) | Group Chat-Upgraded Group announcement-Block-Obtain all the child blocks |
|
|
704
|
+
| docx.v1.chatAnnouncementBlock.get | [Obtain the block content in group announcement](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/get) | Group Chat-Upgraded Group announcement-Block-Obtain the block content in group announcement |
|
|
705
|
+
| docx.v1.chatAnnouncementBlock.list | [Obtain all blocks of a group announcement](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/list) | Group Chat-Upgraded Group announcement-Group announcement-Obtain all blocks of a group announcement |
|
|
706
|
+
| docx.v1.chatAnnouncement.get | [Obtain the basic information of a group announcement](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement/get) | Obtain the basic information of the specified group announcement |
|
|
707
|
+
| docx.v1.documentBlock.batchUpdate | [Batch update blocks](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/batch_update) | Batch update the specified block and return its updated rich text content |
|
|
708
|
+
| docx.v1.documentBlockChildren.batchDelete | [Delete blocks](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/batch_delete) | 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 |
|
|
709
|
+
| docx.v1.documentBlockChildren.create | [Create blocks](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/create) | 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 |
|
|
710
|
+
| docx.v1.documentBlockChildren.get | [Obtain all the child blocks](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/get) | Query the Children Block of the specified Block |
|
|
711
|
+
| docx.v1.documentBlockDescendant.create | [Create nested blocks](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-descendant/create) | Docs-Document-Block-Create nested blocks |
|
|
712
|
+
| docx.v1.documentBlock.get | [Obtain the block content](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/get) | Query the rich text content of the specified block |
|
|
713
|
+
| docx.v1.documentBlock.list | [Obtain all blocks of a document](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list) | Perform a deep traversal of all blocks in the specified document and return them in pagination |
|
|
714
|
+
| docx.v1.documentBlock.patch | [Update a block](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/patch) | Updates the specified block and returns its updated rich text content |
|
|
715
|
+
| docx.v1.document.convert | [Convert Markdown/HTML content into blocks](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/convert) | Docs-Document-Block-Convert Markdown/HTML content into blocks |
|
|
716
|
+
| docx.v1.document.create | [Create a document](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/create) | Create a document whose type is `docx`. This API supports specifying the document title and the folder where the document is to be located |
|
|
717
|
+
| docx.v1.document.get | [Obtain the basic information of a document](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/get) | Obtains the document title and the latest revision ID |
|
|
718
|
+
| docx.v1.document.rawContent | [Obtain the plain text content of the document](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/raw_content) | Obtains the plain text content of the document |
|
|
719
|
+
|
|
720
|
+
## Business domain: driveV1
|
|
721
|
+
| MCP Tool Name | API | Description |
|
|
722
|
+
| --- | --- | --- |
|
|
723
|
+
| drive.v1.exportTask.create | [Create an export task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/create) | This interface is used to create an export file task and returns the export task ID. The export file refers to exporting Feishu documents, spreadsheets, and multidimensional spreadsheets to local files, including formats such as Word, Excel, PDF, and CSV. This interface is asynchronous, requiring a subsequent call to the [Query Export Task Result] interface to obtain the export result. For a complete understanding of the export steps, refer to the [Export docs overview] |
|
|
724
|
+
| drive.v1.exportTask.get | [Query export task results](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/get) | According to the export task ID (ticket) returned by the [Create Export Task] interface, poll the export task result and return the token of the export file. You can use this token to call the [Download Export File] interface to download the exported file to your local device. For a complete understanding of the export file steps, refer to the [Export docs overview] |
|
|
725
|
+
| drive.v1.fileComment.batchQuery | [Batch Query Comments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/batch_query) | 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) |
|
|
726
|
+
| drive.v1.fileComment.create | [Add a Global Comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/create) | Adds a global comment to Docs |
|
|
727
|
+
| drive.v1.fileComment.get | [Get a whole comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/get) | Obtains a specified global comment in Docs. Local comments are not supported yet |
|
|
728
|
+
| drive.v1.fileComment.list | [Get Document Comments in Pages](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list) | 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 |
|
|
729
|
+
| drive.v1.fileComment.patch | [Solve or Restore a Comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/patch) | Solves or restores a comment on a document in Docs |
|
|
730
|
+
| drive.v1.fileCommentReply.delete | [Delete Reply](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/delete) | Deletes a reply to a document in Docs |
|
|
731
|
+
| drive.v1.fileCommentReply.list | [Get Replies List](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/list) | This interface is used to obtain replies according to the comment ID and pagination parameters |
|
|
732
|
+
| drive.v1.fileCommentReply.update | [Update Reply](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/update) | Updates a reply to a document in Docs |
|
|
733
|
+
| drive.v1.file.copy | [Copy File](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy) | Copy a file to a different folder in the user's Space. Folders cannot be copied. This interface is asynchronous |
|
|
734
|
+
| drive.v1.file.createFolder | [Create Folder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder) | Creates a new empty folder within the specified parent folder in the user's Space |
|
|
735
|
+
| drive.v1.file.createShortcut | [Create file shortcut](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_shortcut) | Create shortcut to specified Docs in other folders in Space |
|
|
736
|
+
| drive.v1.file.delete | [Delete file or folder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete) | 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 |
|
|
737
|
+
| drive.v1.file.deleteSubscribe | [Unsubscribe Docs events](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete_subscribe) | 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] |
|
|
738
|
+
| drive.v1.file.getSubscribe | [Get Docs events subscription status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/get_subscribe) | 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] |
|
|
739
|
+
| drive.v1.file.list | [List items in folder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list) | 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), and folders |
|
|
740
|
+
| drive.v1.file.move | [Move a file or folder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/move) | Move a file or folder to a different location in the user's Space |
|
|
741
|
+
| drive.v1.fileStatistics.get | [Obtain file's statistics](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-statistics/get) | This API is used to obtain file's statistics, including the number of unique visitors (UVs), the number of page views (PVs), and the number of likes |
|
|
742
|
+
| drive.v1.file.subscribe | [Subscribe Docs events](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe) | 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] |
|
|
743
|
+
| drive.v1.fileSubscription.create | [Create Subscription](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/create) | Subscribe to change events in the document, currently supporting document comment subscriptions |
|
|
744
|
+
| drive.v1.fileSubscription.get | [Get subscription status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/get) | Get the status of the subscription based on the subscription ID |
|
|
745
|
+
| drive.v1.fileSubscription.patch | [update subscription status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/patch) | Update subscription status based on subscription ID |
|
|
746
|
+
| drive.v1.file.taskCheck | [Query Task Status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check) | Query the status information of asynchronous tasks. Currently supports moving and deleting folder tasks |
|
|
747
|
+
| drive.v1.file.uploadFinish | [Upload a file in blocks-Completing](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_finish) | Completes an upload task |
|
|
748
|
+
| drive.v1.file.uploadPrepare | [Upload a file in blocks-Preuploading](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare) | Send an initialization request to obtain the upload ID and split strategy, preparing for [Uploading blocks]. The platform consistently chunks files into 4MB segments. To understand the complete file upload process, refer to [File Upload Overview] |
|
|
749
|
+
| drive.v1.fileVersion.create | [Create document version](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/create) | Create a document version based on the existing document. The document supports Feishu document and spreadsheet. This interface is asynchronous |
|
|
750
|
+
| drive.v1.fileVersion.delete | [Delete document version](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/delete) | Delete document version. The document supports Feishu document and spreadsheet |
|
|
751
|
+
| drive.v1.fileVersion.get | [Get document version](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get) | Get document version. The document can be Feishu document or spreadsheet. The version information includes the version title, version ID, version creator, create time, and more |
|
|
752
|
+
| drive.v1.fileVersion.list | [List document version](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list) | Get all versions of the document. The document can be Feishu document or spreadsheet |
|
|
753
|
+
| drive.v1.fileViewRecord.list | [Obtain document view records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list) | Obtain the view records of files, including document, sheet, base, wiki, and more. The view records contains the ID, profile, and last view time of the viewers |
|
|
754
|
+
| drive.v1.importTask.create | [Create an import task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/create) | This interface is used to create a task for importing a file and return the import task ID. Importing files involves transferring local files such as Word, TXT, Markdown, Excel, etc., into various cloud document formats such as online documents, spreadsheets, base, etc., and storing them in a specified directory in the cloud. This interface is asynchronous, you need to continue to call the [query import task result] interface to get the result of the import. For details, refer to [Import file overview] |
|
|
755
|
+
| drive.v1.importTask.get | [Query import task result](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/get) | Polling the import results based on the `ticket` returned from [Create import task]. For details, see [Import file overview] |
|
|
756
|
+
| drive.v1.media.batchGetTmpDownloadUrl | [Get Temporary Download URL of Media](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/batch_get_tmp_download_url) | Obtain the temporary download URL of a material based on a `file_tokens`. The URL is valid for 24 hours |
|
|
757
|
+
| drive.v1.media.uploadFinish | [Upload media in blocks-Completing](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_finish) | After calling the [Uploading] interface to upload all the shards, you need to call this interface to trigger the completion of the upload. For a complete understanding of the shard upload process, refer to [Media overview] |
|
|
758
|
+
| drive.v1.media.uploadPrepare | [Upload media in blocks-Preuploading](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_prepare) | Send an initialization request to obtain the upload transaction ID and shard strategy, in preparation for [Uploading media]. The platform segments media into fixed 4MB shards. For a complete understanding of the shard upload process, refer to [Media overview] |
|
|
759
|
+
| drive.v1.meta.batchQuery | [Obtain Metadata](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/meta/batch_query) | Get metadata of various Docs based on file's token, including the title, owner, create time, and more |
|
|
760
|
+
| drive.v1.permissionMember.auth | [Check whether the current user has a specific permission](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth) | This API is used to check whether the current login user has a specific permission on a document based on a filetoken |
|
|
761
|
+
| drive.v1.permissionMember.batchCreate | [Batch create members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/batch_create) | This interface is used to add permissions on a document for some users based on a cloud document token |
|
|
762
|
+
| drive.v1.permissionMember.create | [Add permissions](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create) | Add collaborators to the specified cloud document. Collaborators can be users, groups, departments, user groups, etc |
|
|
763
|
+
| drive.v1.permissionMember.delete | [DeletePermissionMember](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete) | This API is used to delete permissions of a document collaborator based on a filetoken |
|
|
764
|
+
| drive.v1.permissionMember.list | [Obtain a collaborator list(New version)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list) | This API is used to query collaborators based on a filetoken |
|
|
765
|
+
| drive.v1.permissionMember.transferOwner | [Transfer owner](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner) | This API is used to transfer a document owner based on file token and user information |
|
|
766
|
+
| drive.v1.permissionMember.update | [UpdatePermissionMember](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update) | This API is used to update permissions of a document collaborator based on a filetoken |
|
|
767
|
+
| drive.v1.permissionPublic.get | [GetPermissionPublic](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/get) | This interface is used to obtain permission settings for cloud documents according to filetoken |
|
|
768
|
+
| drive.v1.permissionPublicPassword.create | [Open password](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create) | This interface is used to enable the password of the cloud document according to the filetoken |
|
|
769
|
+
| drive.v1.permissionPublicPassword.delete | [Close password](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete) | This interface is used to disable the password of cloud doc more filetoken |
|
|
770
|
+
| drive.v1.permissionPublicPassword.update | [Refresh password](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update) | This interface is used to refresh the password of cloud doc more filetoken |
|
|
771
|
+
| drive.v1.permissionPublic.patch | [Update document sharing settings](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/patch) | This API is used to update the common settings of a document based on a filetoken |
|
|
772
|
+
|
|
773
|
+
## Business domain: driveV2
|
|
774
|
+
| MCP Tool Name | API | Description |
|
|
775
|
+
| --- | --- | --- |
|
|
776
|
+
| drive.v2.fileLike.list | [List Document's Likes](https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/file-like/list) | Get the list of likes for the specified document and returns by like time from near to far. This API supports paging |
|
|
777
|
+
| drive.v2.permissionPublic.get | [GetPermissionPublic](https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get) | This interface is used to obtain permission settings for cloud documents according to filetoken |
|
|
778
|
+
| drive.v2.permissionPublic.patch | [UpdatePermissionPublic](https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch) | This API is used to update the common settings of a document based on a filetoken |
|
|
779
|
+
|
|
780
|
+
## Business domain: ehrV1
|
|
781
|
+
| MCP Tool Name | API | Description |
|
|
782
|
+
| --- | --- | --- |
|
|
783
|
+
| ehr.v1.employee.list | [Employee directory information batch retrieval](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list) | You can batch retrieve employee directory fields with filters, such as Feishu user ID, employee status, and employee type. Directory fields can be divided into system fields (system_fields) and custom fields (custom_fields) |
|
|
784
|
+
|
|
785
|
+
## Business domain: eventV1
|
|
786
|
+
| MCP Tool Name | API | Description |
|
|
787
|
+
| --- | --- | --- |
|
|
788
|
+
| event.v1.outboundIp.list | [Get event's outbound IP](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list) | When Feishu Open Platform pushes events to the callback address configured by the application, it is sent out through a specific IP, and the application can get all relevant IP addresses through this interface |
|
|
789
|
+
|
|
790
|
+
## Business domain: helpdeskV1
|
|
791
|
+
| MCP Tool Name | API | Description |
|
|
792
|
+
| --- | --- | --- |
|
|
793
|
+
| helpdesk.v1.notification.cancelApprove | [Cancel approval](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_approve) | Call this API to cancel the review after submission |
|
|
794
|
+
| helpdesk.v1.notification.cancelSend | [Cancel notification](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_send) | Cancel push API. This API can be called when waiting for the scheduled sending after approval, during message sending (the message sent will be recalled), and after sending (all the messages sent will be recalled) |
|
|
795
|
+
| helpdesk.v1.notification.create | [Create notification](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/create) | The API is called to create a push, which is in draft status after being created |
|
|
796
|
+
| helpdesk.v1.notification.executeSend | [Push message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/execute_send) | After approval, call this API to set the push time, and wait for the scheduling system to send the message |
|
|
797
|
+
| helpdesk.v1.notification.get | [Query notification](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/get) | Query push details |
|
|
798
|
+
| helpdesk.v1.notification.patch | [Update notification](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/patch) | Update push message. This API can only be called when the message is in draft status |
|
|
799
|
+
| helpdesk.v1.notification.preview | [Preview notification](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/preview) | This API can be called to preview the set push content before the push |
|
|
800
|
+
| helpdesk.v1.notification.submitApprove | [Submit approval](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/submit_approve) | Normally, the "Submit for review" API can be called after the "Create push" API is called. If the creator is the Help Desk owner, the push message will be automatically approved; otherwise, the Help Desk owner will be notified to review the push message |
|
|
801
|
+
|
|
802
|
+
## Business domain: hireV1
|
|
803
|
+
| MCP Tool Name | API | Description |
|
|
804
|
+
| --- | --- | --- |
|
|
805
|
+
| hire.v1.advertisement.publish | [Publish job post](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/advertisement/publish) | Publish advertisement |
|
|
806
|
+
| hire.v1.agency.batchQuery | [Search supplier list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/batch_query) | Supplier information can be queried according to headhunting supplier ID list or keywords and filters |
|
|
807
|
+
| hire.v1.agency.get | [Get agency information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/get) | Get agency information by ID |
|
|
808
|
+
| hire.v1.agency.getAgencyAccount | [Query the headhunting list of suppliers](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/get_agency_account) | Query the headhunting list according to the headhunting supplier ID |
|
|
809
|
+
| hire.v1.agency.operateAgencyAccount | [Disable/undisable headhunting under headhunting supplier](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/operate_agency_account) | The headhunter can be disabled/undisabled according to the headhunter ID |
|
|
810
|
+
| hire.v1.agency.protect | [Set agency protection period](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/protect) | Set agency protection period |
|
|
811
|
+
| hire.v1.agency.protectSearch | [Query agency protection period information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/protect_search) | Query agency protection period information |
|
|
812
|
+
| hire.v1.agency.query | [Query agency information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/agency/query) | Query agency information by name |
|
|
813
|
+
| hire.v1.application.cancelOnboard | [Cancel candidate enrollment](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/cancel_onboard) | The operation candidate cancels the entry, which is applicable to cancel the entry in the waiting stage |
|
|
814
|
+
| hire.v1.application.create | [Create application](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/create) | Create application by job ID and talent ID |
|
|
815
|
+
| hire.v1.application.get | [Get application information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get) | Get application by application ID |
|
|
816
|
+
| hire.v1.application.getDetail | [Get application detail](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get_detail) | Call the interface to obtain the application information and other entity information related to the delivery according to the delivery ID. The information of which related entities can be obtained on demand through the options parameter |
|
|
817
|
+
| hire.v1.applicationInterview.list | [Get Interview List](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application-interview/list) | Deprecated Version (Not Recommended)-Hire-Interview-Get Interview List |
|
|
818
|
+
| hire.v1.application.list | [Get application list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list) | Get application list by query condition |
|
|
819
|
+
| hire.v1.application.offer | [Get offer information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/offer) | Get offer information application ID |
|
|
820
|
+
| hire.v1.application.recover | [Recover Application](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/recover) | Recover "terminated" deliveries according to the application ID |
|
|
821
|
+
| hire.v1.application.terminate | [Terminate application](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/terminate) | Modify the application status to "terminated" according to the application ID |
|
|
822
|
+
| hire.v1.application.transferOnboard | [Transfer talent to onboarding](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/transfer_onboard) | Manage candidate onboarding and create employees according to the delivery ID. The delivery must be in the "Prehire" stage, and the delivery status can be changed through the "Transfer Stage" interface |
|
|
823
|
+
| hire.v1.application.transferStage | [Transfer delivery stage](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/transfer_stage) | Transfer delivery stage. When "All positions require offer approval" is turned on, the offer will be transferred to the waiting stage that requires approval |
|
|
824
|
+
| hire.v1.attachment.get | [Get attachment information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/attachment/get) | Obtain the meta-information of the attachment in the recruitment system according to the ID of the talent resume attachment, such as file name, creation time, file URL, etc., The resume attachment of the talent can be obtained through the [Access Talent Information] Interface |
|
|
825
|
+
| hire.v1.attachment.preview | [Get attachment PDF download link](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/attachment/preview) | Obtain the attachment preview information according to the ID of the talent resume attachment, and obtain the resume attachment of the talent through the [Get talent] api |
|
|
826
|
+
| hire.v1.backgroundCheckOrder.list | [Get background check info list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/background_check_order/list) | Get the background check order information in batches according to the application ID or background check update time |
|
|
827
|
+
| hire.v1.diversityInclusion.search | [Get Additional Info in Application Form](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/diversity_inclusion/search) | Get application form additional information of candidates. You can query by Application ID or Talent ID |
|
|
828
|
+
| hire.v1.ecoAccountCustomField.batchDelete | [Delete account customized fields](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/batch_delete) | Feishu Hire's back check or written test service provider can delete account customization fields (such as the customer's tenant ID, account ID, etc.) at the service provider through this interface |
|
|
829
|
+
| hire.v1.ecoAccountCustomField.batchUpdate | [Update account customized fields](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/batch_update) | Feishu Hire's back-end or written test service provider can update the name and description of account customization fields (such as the customer's tenant ID at the service provider, account ID, etc.) through this interface |
|
|
830
|
+
| hire.v1.ecoAccountCustomField.create | [Create account customized field](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account_custom_field/create) | Feishu Hire's back check or written test service provider can create account customization fields through this interface to identify the identity of Feishu Hire customers at the service provider (such as the customer's tenant ID, account ID, etc.) |
|
|
831
|
+
| hire.v1.ecoBackgroundCheckCustomField.batchDelete | [Delete background check customized fields](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/batch_delete) | Delete the form custom fields that the user displays when initiating a back call |
|
|
832
|
+
| hire.v1.ecoBackgroundCheckCustomField.batchUpdate | [Update background check customized fields](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/batch_update) | Updates the form custom field names and descriptions that the user displays when initiating a back call |
|
|
833
|
+
| hire.v1.ecoBackgroundCheckCustomField.create | [Push background check customzied fields](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/create) | Customize the form fields that the user displays when launching the background check. The field can be set to required or non-required |
|
|
834
|
+
| hire.v1.ecoBackgroundCheckPackage.batchDelete | [Delete background check package](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/batch_delete) | Delete the backup plan and additional survey item information under the backup account. The deletion operation will not affect the created backup |
|
|
835
|
+
| hire.v1.ecoBackgroundCheckPackage.batchUpdate | [Update background check package](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/batch_update) | Update the background adjustment package and additional survey item information under the specified background adjustment account. If you need to add a background adjustment package and additional survey items, please use [Create a background adjustment package and additional survey items] to add |
|
|
836
|
+
| hire.v1.ecoBackgroundCheckPackage.create | [Create background check package](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/create) | Creates a list of available backtune packages and a list of additional survey item information under the specified backtune account. The interface is created incrementally, and each call is added to the original package list and the list of additional survey items |
|
|
837
|
+
| hire.v1.ecoBackgroundCheck.cancel | [Cancel background check order](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/cancel) | Calling this interface will change the status of the back-up order to terminated, and the terminated order will not be able to update the order progress to "terminated" through the [Update Back-up Order Progress] and [Return the final result of the back-up order]. Before calling this interface, it is recommended to call the [Update Back-up Order Progress] interface to update the order progress to" terminated " |
|
|
838
|
+
| hire.v1.ecoBackgroundCheck.updateProgress | [Update background check order process](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_progress) | Update the progress information and stage report of the specified back adjustment. The progress information will be displayed on the back adjustment card to push the back adjustment progress and stage report, inform users of the current circulation status of system orders |
|
|
839
|
+
| hire.v1.ecoBackgroundCheck.updateResult | [Update background check order result](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_result) | Return the final result and final report of the back call. After the back call, if the tenant does not enable the back call report approval function, the back call order status will directly change to "Completed". If the back call report approval function is enabled, the order status will flow to "Completed" after the administrator approval is approved |
|
|
840
|
+
| hire.v1.ecoExamPaper.batchDelete | [Delete exam paper list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/batch_delete) | Feishu Hire's written test service provider can delete the list of test papers under the customer's written test account through this interface. The deletion operation does not affect the scheduled written test, and there will be no error when deleting non-existent test papers |
|
|
841
|
+
| hire.v1.ecoExamPaper.batchUpdate | [Update exam paper](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/batch_update) | Feishu Hire's written test service provider can update the list of test papers under the customer's written test account through this interface |
|
|
842
|
+
| hire.v1.ecoExamPaper.create | [Create exam paper](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/create) | Feishu Hire's written test service provider can create a list of test papers under the customer's written test account through this interface after completing [Account Binding]. If the customer's written test account is "not activated" or "disabled", after the test paper is created successfully, the customer's account will become "normal" and the written test can be arranged normally |
|
|
843
|
+
| hire.v1.ecoExam.loginInfo | [Post exam login info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam/login_info) | The written test service provider of Feishu Hire, after receiving the [Create Written Test] event and arranging the written test, should go through this interfaceReturn the result of the written test arrangement. If the arrangement is successful, the written test link must be returned; if the written test link requires login authentication, the login certificate(`username`, `password`) must be returned |
|
|
844
|
+
| hire.v1.ecoExam.updateResult | [Post exam result](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam/update_result) | Feishu Hire's written test service provider can send back the candidate's written test results through this interface. After returning the written test results, the candidate's written test status in Feishu Hire will change to "Answered" |
|
|
845
|
+
| hire.v1.ehrImportTask.patch | [Update e-HR importing task](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/ehr_import_task/patch) | Update e-HR importing task |
|
|
846
|
+
| hire.v1.employee.get | [Get onboard information by employee ID](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get) | Get employee info by employee ID |
|
|
847
|
+
| hire.v1.employee.getByApplication | [Get onboard information by application ID](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get_by_application) | Get employee info by application ID |
|
|
848
|
+
| hire.v1.employee.patch | [Update talent onboarding status](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/patch) | Update employee's employment status and resignation status by employee ID |
|
|
849
|
+
| hire.v1.evaluationTask.list | [Get employee evaluation tasks](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation_task/list) | Get employee evaluation tasks |
|
|
850
|
+
| hire.v1.evaluation.list | [Get resume evaluation information list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation/list) | Batch get resume evaluation information |
|
|
851
|
+
| hire.v1.examMarkingTask.list | [Get user exam marking tasks](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam_marking_task/list) | Get employee written examination marking tasks |
|
|
852
|
+
| hire.v1.exam.create | [Add written test results](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/exam/create) | Add the written test result under the delivery according to the delivery ID |
|
|
853
|
+
| hire.v1.externalApplication.create | [Create external application](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/create) | Create external application |
|
|
854
|
+
| hire.v1.externalApplication.delete | [Delete External Application](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/delete) | Delete external delivery |
|
|
855
|
+
| hire.v1.externalApplication.list | [Get External Application Info list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/list) | Obtain external delivery information of talents according to talent ID |
|
|
856
|
+
| hire.v1.externalApplication.update | [Update External Application Info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_application/update) | Update external delivery, overwrite and update the fields of external delivery |
|
|
857
|
+
| hire.v1.externalBackgroundCheck.batchQuery | [Query external background](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/batch_query) | According to the external delivery ID or external backtone ID list, query the external backtone information |
|
|
858
|
+
| hire.v1.externalBackgroundCheck.create | [Create external background check](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/create) | Create external background check |
|
|
859
|
+
| hire.v1.externalBackgroundCheck.delete | [Delete external background](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/delete) | Delete external accent |
|
|
860
|
+
| hire.v1.externalBackgroundCheck.update | [Update external background](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_background_check/update) | Update the external backtune, overwrite and update the fields of the external backtune |
|
|
861
|
+
| hire.v1.externalInterviewAssessment.create | [Create external interview assessment](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview_assessment/create) | Create external interview assessment |
|
|
862
|
+
| hire.v1.externalInterviewAssessment.patch | [Update the external review](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview_assessment/patch) | Update the external review fields. Fields left empty won't be updated |
|
|
863
|
+
| hire.v1.externalInterview.batchQuery | [Query external interview](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/batch_query) | Query the external interview information based on the list of external delivery IDs or external interview IDs |
|
|
864
|
+
| hire.v1.externalInterview.create | [Create external interview](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/create) | Create external interview |
|
|
865
|
+
| hire.v1.externalInterview.delete | [Delete external interview](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/delete) | Delete the external interview |
|
|
866
|
+
| hire.v1.externalInterview.update | [Update external interview](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_interview/update) | Update the external interview to overwrite the fields for the external interview |
|
|
867
|
+
| hire.v1.externalOffer.batchQuery | [Query external offer list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/batch_query) | According to the external delivery ID or the external Offer ID list, query the external Offer information |
|
|
868
|
+
| hire.v1.externalOffer.create | [Create external Offer](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/create) | Import offer information from other systems and create it as an external offer |
|
|
869
|
+
| hire.v1.externalOffer.delete | [Delete external offer](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/delete) | Remove External Offer |
|
|
870
|
+
| hire.v1.externalOffer.update | [Update external offer](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_offer/update) | Update the external Offer to overwrite the fields of the external Offer |
|
|
871
|
+
| hire.v1.externalReferralReward.create | [Import external referral rewards](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_referral_reward/create) | Supports the import of external referral rewards (credit/cash) into the referral account |
|
|
872
|
+
| hire.v1.externalReferralReward.delete | [Delete External Referral Reward](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/external_referral_reward/delete) | - Support to delete the imported referral reward in "Import External Rewards" by ID. After deletion, the corresponding details in "Referral Rewards Management" in the recruitment system will disappear- If you delete the "confirmed" and "issued" rewards, the referral will disappear in the "My Rewards" details, please pay attention to communicating with the referrals involved in advance |
|
|
873
|
+
| hire.v1.interviewFeedbackForm.list | [Get Interview Feedback Form Details](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_feedback_form/list) | Retrieve detailed information of the interview feedback form by ID, including question descriptions, question options, etc |
|
|
874
|
+
| hire.v1.interviewRecordAttachment.get | [Get interview feedback attachment](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record-attachment/get) | Get the interview feedback attachment in PDF format |
|
|
875
|
+
| hire.v1.interviewRecord.get | [Get interview evaluation details](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record/get) | Get interview evaluation details |
|
|
876
|
+
| hire.v1.interviewRecord.list | [List interview assessment](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_record/list) | Obtain interview evaluation details in batches. The returned results are sorted by ID by default |
|
|
877
|
+
| hire.v1.interviewRegistrationSchema.list | [Get interview registration schema list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_registration_schema/list) | Get interview registration schema list |
|
|
878
|
+
| hire.v1.interviewRoundType.list | [Get a list of interview rounds](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_round_type/list) | Get a list of interview rounds |
|
|
879
|
+
| hire.v1.interviewTask.list | [Get employee interview tasks](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview_task/list) | Get employee interview tasks |
|
|
880
|
+
| hire.v1.interview.getByTalent | [Get talent interview information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/get_by_talent) | Get talent interview information |
|
|
881
|
+
| hire.v1.interview.list | [Get interview information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interview/list) | Obtain interview information based on delivery ID or interview time |
|
|
882
|
+
| hire.v1.interviewer.list | [List Interviewer Info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/list) | Paged to query the list of interviewers, the interface will only return the data of the user who has performed "Update Interviewer Information", and the data that cannot be queried through the interface will default to "Uncertified" interviewers. The interface will be pulled sequentially by default according to the update time, user_id order |
|
|
883
|
+
| hire.v1.interviewer.patch | [Update Interviewer Info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/interviewer/patch) | For updating interviewer certification information |
|
|
884
|
+
| hire.v1.jobFunction.list | [Get a list of functional categories](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_function/list) | Get a list of functional categories |
|
|
885
|
+
| hire.v1.jobProcess.list | [Get recruitment process information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list) | Obtain all recruitment process information. Such as "Process Name", "Process Type" and "Stage Name", "Stage Type" and other information under the process |
|
|
886
|
+
| hire.v1.jobPublishRecord.search | [Get job advertisement posting records](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_publish_record/search) | Get job advertisement posting records |
|
|
887
|
+
| hire.v1.jobRequirementSchema.list | [Get job requirement template](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement_schema/list) | Get the recruitment requirements template |
|
|
888
|
+
| hire.v1.jobRequirement.create | [Create job requirement](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/create) | Create a recruitment requirement, except that the recruitment requirement number is required, whether other fields are required is consistent with the settings in Feishu Recruitment "Recruitment Requirements Field Management" |
|
|
889
|
+
| hire.v1.jobRequirement.delete | [Delete recruitment requirements](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/delete) | Delete recruitment requirements |
|
|
890
|
+
| hire.v1.jobRequirement.list | [Get job requirement list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list) | Get recruitment requirements by job ID |
|
|
891
|
+
| hire.v1.jobRequirement.listById | [Search Job Requirement Info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/list_by_id) | Obtain recruitment demand information according to "Recruitment Demand ID", support batch inquiry |
|
|
892
|
+
| hire.v1.jobRequirement.update | [Update job requirement](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/update) | Update the information of the specified recruitment request, including its name, status, requested headcount, etc. (Pending recruitment requests can't be updated.) |
|
|
893
|
+
| hire.v1.jobSchema.list | [Get job templates](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_schema/list) | Get the job fields in the social recruitment and campus recruitment job templates. The returned results include system default fields and custom fields. Recruitment administrators can modify the job template in "Feishu Hire" - "Settings" - "Job Management" - "Job Field Management" |
|
|
894
|
+
| hire.v1.jobType.list | [List job type](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_type/list) | Obtain a list of job categories preset by the recruitment system, which can be used to operate positions (such as [New Job]), and backfill job category fields when operating recruitment requirements (such as [Create Job Requirement]. The return list is sorted in ascending order by creation time by default, and contains the hierarchical relationship of nodes (the parent node ID of the node). You can build their own job category tree after obtaining the full amount of data |
|
|
895
|
+
| hire.v1.job.close | [Close job](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/close) | It supports closing positions. After closing, positions will be synchronized offline from the official website, internal push and headhunting channels |
|
|
896
|
+
| hire.v1.job.combinedCreate | [Create job](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_create) | Whether the new job field is required or not is subject to the settings in the "Job Field Management" in the system |
|
|
897
|
+
| hire.v1.job.combinedUpdate | [Update job](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_update) | Update job. This interface is for full update. If the field is not filled with value, the original value will be cleared. Whether the field is required or not will be subject to the settings in the "Mange Job Fields" in the system |
|
|
898
|
+
| hire.v1.job.config | [Get job config info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/config) | Get job config info |
|
|
899
|
+
| hire.v1.job.get | [Get job info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/get) | Get job info by ID |
|
|
900
|
+
| hire.v1.job.getDetail | [Get job details](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/get_detail) | Get the job details according to the job ID, including basic job information, job settings, and a list of related recruitment stores |
|
|
901
|
+
| hire.v1.job.list | [Get job list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/list) | Get job list |
|
|
902
|
+
| hire.v1.jobManager.batchUpdate | [Update job managers](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job-manager/batch_update) | Update job related personnel |
|
|
903
|
+
| hire.v1.jobManager.get | [Get job manager](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job-manager/get) | Obtain the recruiter information on the position according to the position ID, such as the person in charge of the recruitment, the hiring manager |
|
|
904
|
+
| hire.v1.job.open | [Open job](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/open) | For closed jobs, you can restart them through this interface |
|
|
905
|
+
| hire.v1.job.recruiter | [Get job manager](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/recruiter) | Obtain the recruiter information on the position according to the position ID, such as the person in charge of the recruitment, the hiring manager |
|
|
906
|
+
| hire.v1.job.updateConfig | [Update job config](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/update_config) | Update job settings, including interview evaluation form, offer application form, etc.If no data is entered during update of the required field, the interface will report an error about the update failure |
|
|
907
|
+
| hire.v1.location.list | [Get address list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/list) | Get address list |
|
|
908
|
+
| hire.v1.location.query | [Query address list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query) | Query the location list based on the location type and location code to obtain location name information |
|
|
909
|
+
| hire.v1.minutes.get | [Get interview minutes details](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/minutes/get) | Get interview minutes details for the assigned interview |
|
|
910
|
+
| hire.v1.note.create | [Create note](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/create) | Create note information |
|
|
911
|
+
| hire.v1.note.delete | [Delete Note](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/delete) | Delete specified remarks |
|
|
912
|
+
| hire.v1.note.get | [Get note](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/get) | Get note data by ID |
|
|
913
|
+
| hire.v1.note.list | [Get note list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/list) | Get note list |
|
|
914
|
+
| hire.v1.note.patch | [Update note](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/patch) | Update note data |
|
|
915
|
+
| hire.v1.offerApplicationForm.get | [Get offer application form template infomation](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_application_form/get) | Get offer application form template infomation |
|
|
916
|
+
| hire.v1.offerApplicationForm.list | [Get offer application form list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_application_form/list) | Get offer application form list |
|
|
917
|
+
| hire.v1.offerCustomField.update | [Update offer apply form custom fields](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_custom_field/update) | - This document supports updating the custom field configuration of the Offer application form in "Feishu Hire" - "Settings" - "Offer Application Form Settings" through the interface; - After the current modification of the application form information (including updating the custom fields), the schema_id of all application forms will be updated, that is, a new version will be added to all application forms, and the schema_id of the application form will be used in creating and updating offers; - After the custom field of the Offer application form in "Feishu Hire" is created, it is not supported to modify the field type, and this interface does not support updating the field type; - If the current field type is "formula", it does not support updating through the interface |
|
|
918
|
+
| hire.v1.offerSchema.get | [Get Offer Schema Information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer_schema/get) | Deprecated Version (Not Recommended)-Hire-offer-Get Offer Schema Information |
|
|
919
|
+
| hire.v1.offer.create | [Create offer](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/create) | Create offers from the application and apply form |
|
|
920
|
+
| hire.v1.offer.get | [Get offer details](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/get) | Get offer details based on offer ID |
|
|
921
|
+
| hire.v1.offer.internOfferStatus | [Update internship offer entry/exit status](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/intern_offer_status) | Confirmation or abandonment of an internship offer in the "Internship pending" status, or termination of an internship offer in the "Internship enrolled" status |
|
|
922
|
+
| hire.v1.offer.list | [Get offer list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/list) | Get offer list based on talent ID |
|
|
923
|
+
| hire.v1.offer.offerStatus | [Update Offer Status](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/offer_status) | Update the status of the candidate Offer with the Offer ID.- To update the approval status of the Offer, you need to open "Create and approve an Offer through the OA system" in "Settings - Offer Settings - Offer Rule Settings" in the system. If the current Offer has been approved through Feishu Hire, the approval status of the Offer cannot be updated through this interface- To update the sending and accepting status of the Offer, you need to enable "Send Offer through the OA system" in "Settings - Offer Settings - Offer Rule Settings" in the system; only the delivery stage is supported to be updated before "Pending onboarding"; if the current Offer has been sent through Feishu Hire If it has been sent to candidates, the sending and receiving status of the Offer cannot be updated through this interface |
|
|
924
|
+
| hire.v1.offer.update | [Update offer info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/update) | Update offer information, including basic information, salary information, and custom information |
|
|
925
|
+
| hire.v1.questionnaire.list | [Get a list of interview satisfaction questionnaires](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/questionnaire/list) | Get a list of interview satisfaction questionnaires |
|
|
926
|
+
| hire.v1.referralAccount.create | [Register Referral Account for External System](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/create) | You can register a "Referral reward account" with the referrer's phone number or email address to obtain the corresponding referrer's account ID and query and perform actions on the referrer's account balance (credits/rewards) by using ["Referral account balance change"] and ["Withdraw referral account balance"] interfaces. If you need to disable this account, call the ["Disable referral account"] interface |
|
|
927
|
+
| hire.v1.referralAccount.deactivate | [Disable Referral Account for External System](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/deactivate) | Once you disable this referral account, its information won't be able to be obtained or modified via the ["Referral account balance change"] or ["Withdraw referral account balance"] interface |
|
|
928
|
+
| hire.v1.referralAccount.enable | [Activate referral account](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/enable) | Enable the account according to the account ID. After activation, you can obtain and modify it through the interface ["referral account balance change event"], ["withdrawal of referral account balance"] |
|
|
929
|
+
| hire.v1.referralAccount.getAccountAssets | [Query referral account](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/get_account_assets) | Query the referral account info according to the account ID |
|
|
930
|
+
| hire.v1.referralAccount.reconciliation | [Withdrawal and Reconciliation API of Referral Account](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/reconciliation) | You can sync the account top-up information within the time period to the recruitment system at a fixed time. The data will be compared against the withdrawn amount from the system to ensure prompt detection of top-up errors or other errors in the event of system exceptions or other unexpected circumstances |
|
|
931
|
+
| hire.v1.referralAccount.withdraw | [Withdraw Balance from Referral Account in Full Amount](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/withdraw) | You can withdraw rewards (credits or cash) from the referral account in full with the account ID. Before you call the interface, make sure you've completed the ["Register referral account for external system"] step and obtained the account ID. After the withdrawal, the referrer's account balance (credits or cash) will be zeroed, and the reward amount deducted will be marked as "Issued" in the recruitment system |
|
|
932
|
+
| hire.v1.referralWebsiteJobPost.get | [Obtain Job Post Details of Referral Official Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/get) | Obtain Job Post Details of Referral Official Website by Post ID |
|
|
933
|
+
| hire.v1.referralWebsiteJobPost.list | [Obtain Job List of Referral Official Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_website-job_post/list) | Obtain the job list of the referral official website. Custom data can't be obtained from the interface. The job list with custom data can be obtained from "Obtain Job Post Details from Referral Official Website" |
|
|
934
|
+
| hire.v1.referral.getByApplication | [Get referral](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral/get_by_application) | Get referral by application ID |
|
|
935
|
+
| hire.v1.referral.search | [Query talent referral information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral/search) | Query talent referral information, sorted by the "Creation time" of the referral application in descending order |
|
|
936
|
+
| hire.v1.registrationSchema.list | [Obtain List of Information Registration Form Templates](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/registration_schema/list) | Obtain List of Information Registration Form Templates |
|
|
937
|
+
| hire.v1.resumeSource.list | [Get resume source list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/resume_source/list) | Get resume source list |
|
|
938
|
+
| hire.v1.role.get | [Get Role Detail](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/get) | Obtain role details, including name, description, permission list, etc(Applicable to new version permissions. Regarding the main differences between new and old version permissions: the new permission system distinguishes between campus and experienced hire and separates permissions into feature permissions, field permissions, and data permissions) |
|
|
939
|
+
| hire.v1.role.list | [Get role list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/role/list) | Get a list of roles |
|
|
940
|
+
| hire.v1.subject.list | [Get subject list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/subject/list) | Get subject list |
|
|
941
|
+
| hire.v1.talentBlocklist.changeTalentBlock | [Add/remove block list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_blocklist/change_talent_block) | Add/remove talents from the blocked list based on their talent ID |
|
|
942
|
+
| hire.v1.talentFolder.list | [Get talent folder information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_folder/list) | Used to obtain talent folder information in the recruitment system |
|
|
943
|
+
| hire.v1.talentObject.query | [Get talent field](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query) | Get talent field |
|
|
944
|
+
| hire.v1.talentOperationLog.search | [Search talent operation log list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/talent_operation_log/search) | Query the operation record of the operator to the talent |
|
|
945
|
+
| hire.v1.talentPool.batchChangeTalentPool | [Add/remove talents from the talent pool in batches](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/batch_change_talent_pool) | For the same talent pool, talent addition or removal operations can be performed in batches |
|
|
946
|
+
| hire.v1.talentPool.moveTalent | [Add Talent to Talent Pool](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/move_talent) | Add talents to the talent pool |
|
|
947
|
+
| hire.v1.talentPool.search | [Get Talent Pool List](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_pool/search) | Get the list of talent pools |
|
|
948
|
+
| hire.v1.talentTag.list | [Get talent tag info list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_tag/list) | You can obtain the talent tag information list by keyword, ID list, type, and active/inactive status. The list is arranged in reverse order by creation time |
|
|
949
|
+
| hire.v1.talent.addToFolder | [Add talents to folder](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/add_to_folder) | Add talents to the specified folder |
|
|
950
|
+
| hire.v1.talent.batchGetId | [Get talent ID by mobile or email](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/batch_get_id) | Get talent ID by mobile phone number or email |
|
|
951
|
+
| hire.v1.talent.combinedCreate | [Create talent](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/combined_create) | Used to create a talent within the enterprise. The name is a required field preset by the system. For email/phone fields, please confirm whether it is required in the Feishu recruitment standard resume template settings. Custom field information can be obtained with the 「Get Talent Field」 interface |
|
|
952
|
+
| hire.v1.talent.combinedUpdate | [Update talent information](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/combined_update) | Used to update a talent in the enterprise. The name is a required field preset by the system. For email/phone fields, please confirm whether it is required in the Feishu recruitment standard resume template settings. Custom field information can be obtained with the 「Get Talent Field」 interface |
|
|
953
|
+
| hire.v1.talentExternalInfo.create | [Create talent external info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent-external_info/create) | Create talent external information |
|
|
954
|
+
| hire.v1.talentExternalInfo.update | [Update external talent info](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent-external_info/update) | Update external talent information |
|
|
955
|
+
| hire.v1.talent.get | [Get talent V1](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/get) | Get talent by ID |
|
|
956
|
+
| hire.v1.talent.list | [Get talent list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/list) | Get talent list |
|
|
957
|
+
| hire.v1.talent.onboardStatus | [Update Talent Onboard Status](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/onboard_status) | Update the active status of talents. This API is applicable only to candidates who were not hired through applications in Feishu Hire. Candidates marked as "Onboarded" through this API can only be marked as "Offboarded" through the same API |
|
|
958
|
+
| hire.v1.talent.removeToFolder | [Remove talent from specified folder](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/remove_to_folder) | Removes talent from the specified folder based on the talent ID list |
|
|
959
|
+
| hire.v1.talent.tag | [Operate Talent Tag](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/tag) | You can add and remove tags for talent |
|
|
960
|
+
| hire.v1.terminationReason.list | [Get the reason for terminating delivery](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/termination_reason/list) | Gets the default application termination reason in the system and the user-configured custom application termination reason |
|
|
961
|
+
| hire.v1.test.search | [Get a list of written exams](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/test/search) | Batch obtain the written examination information of talents in a delivery process, such as answer status, written examination score, etc. (currently, only 1W pieces of data can be obtained. If the amount of data is large, the full amount of data can be obtained in batches by controlling the test_start_time query criteria.) |
|
|
962
|
+
| hire.v1.todo.list | [Batch get to-dos](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/todo/list) | Batch get to-dos |
|
|
963
|
+
| hire.v1.tripartiteAgreement.create | [Create Tripartite Agreement](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/create) | When the tenant enables the "Sync tripartite agreements via API" switch and configures "Tripartite agreement" at a specific stage in the campus hire process, a tripartite agreement and corresponding status can be created for campus hire with the offer location in Chinese mainland by using the application ID |
|
|
964
|
+
| hire.v1.tripartiteAgreement.delete | [Delete Tripartite Agreement](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/delete) | Delete the three-party agreement in the delivery through the interface |
|
|
965
|
+
| hire.v1.tripartiteAgreement.list | [List Tripartite Agreement](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/list) | Obtain the tripartite agreement information according to the tripartite agreement ID or the application IDSort by id by default |
|
|
966
|
+
| hire.v1.tripartiteAgreement.update | [Update Tripartite Agreement](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/tripartite_agreement/update) | Update the three-party agreement in the delivery through the interface |
|
|
967
|
+
| hire.v1.userRole.list | [Get user role list](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/user_role/list) | Get a list of user role |
|
|
968
|
+
| hire.v1.websiteChannel.create | [Create Promotion Channel of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/create) | Create recruitment official website promotion channels according to the recruitment official website ID and promotion channel name |
|
|
969
|
+
| hire.v1.websiteChannel.delete | [Delete Promotion Channel of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/delete) | Delete the recruitment official website promotion channel according to the recruitment official website ID and promotion channel ID |
|
|
970
|
+
| hire.v1.websiteChannel.list | [Obtain Promotion Channel List of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/list) | Get the list of promotion channels by pagination according to the ID of the recruitment official website |
|
|
971
|
+
| hire.v1.websiteChannel.update | [Update Promotion Channel of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-channel/update) | Change the name of the promotion channel according to the ID of the recruitment official website and the ID of the promotion channel |
|
|
972
|
+
| hire.v1.websiteDeliveryTask.get | [Obtain Resume Analysis and Create Application Result of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery_task/get) | Obtain the delivery task information of official recruitment website. If the obtained data is empty, continue to poll until the data is not empty, and then query the data in the data |
|
|
973
|
+
| hire.v1.websiteDelivery.createByAttachment | [Create Application to Official Recruitment Website by Resume Attachment Analysis](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_attachment) | Create Application to Official Recruitment Website by Resume Attachment Analysis |
|
|
974
|
+
| hire.v1.websiteDelivery.createByResume | [Create Application to Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume) | Create Application to Official Recruitment Website |
|
|
975
|
+
| hire.v1.websiteJobPost.get | [Obtain Job Post Details of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/get) | Obtain Job Post Details of Official Recruitment Website |
|
|
976
|
+
| hire.v1.websiteJobPost.list | [Obtain Job List of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/list) | Get the job list under the recruitment official website. Custom data does not support list acquisition for the time being. Please get it from the "Get job advertisement details under the recruitment official website" interface |
|
|
977
|
+
| hire.v1.websiteJobPost.search | [Search for Job List of Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-job_post/search) | Search for Job List of Official Recruitment Website |
|
|
978
|
+
| hire.v1.website.list | [Obtain List of Official Recruitment Websites](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website/list) | Obtain List of Official Recruitment Websites |
|
|
979
|
+
| hire.v1.websiteSiteUser.create | [Create User on Official Recruitment Website](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-site_user/create) | Create User on Official Recruitment Website |
|
|
980
|
+
|
|
981
|
+
## Business domain: hireV2
|
|
982
|
+
| MCP Tool Name | API | Description |
|
|
983
|
+
| --- | --- | --- |
|
|
984
|
+
| hire.v2.interviewRecord.get | [Get Interview Feedback Detail(new version)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/interview_record/get) | Get interview feedback details |
|
|
985
|
+
| hire.v2.interviewRecord.list | [Batch Get Interview Feedback Details(new version)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/interview_record/list) | Batch get interview feedback |
|
|
986
|
+
| hire.v2.talent.get | [Get talent details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/hire-v2/talent/get) | Obtain talent information according to talent ID |
|
|
987
|
+
|
|
988
|
+
## Business domain: humanAuthenticationV1
|
|
989
|
+
| MCP Tool Name | API | Description |
|
|
990
|
+
| --- | --- | --- |
|
|
991
|
+
| human_authentication.v1.identity.create | [Upload Identity Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/human_authentication-v1/identity/create) | This interface is used to upload the identity information for real-name authentication. Before arousing active living body authentication, this interface needs to be used for real-name authentication |
|
|
992
|
+
|
|
993
|
+
## Business domain: imV1
|
|
994
|
+
| MCP Tool Name | API | Description |
|
|
995
|
+
| --- | --- | --- |
|
|
996
|
+
| im.v1.batchMessage.delete | [Recall messages in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete) | This interface is used to withdraw messages sent through the [batch send message] interface |
|
|
997
|
+
| im.v1.batchMessage.getProgress | [Query the overall progress of a batch message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/get_progress) | After [send batch messages] or [recall batch messages], you can use this interface to query the message send and recall progress |
|
|
998
|
+
| im.v1.batchMessage.readUser | [Query the number of pushers and readers of batch messages](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user) | After [sending messages in batches], you can use this interface to query the total number of people who have received the message push and the number of people who have read the message |
|
|
999
|
+
| im.v1.chatAnnouncement.get | [Obtain group announcement information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/get) | Obtains the group announcement in a chat, with the same format as [Docs] |
|
|
1000
|
+
| im.v1.chatAnnouncement.patch | [Update group announcement info](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-announcement/patch) | Updates the group announcement information in a chat, with the same format as [Docs], newer document formats are not supported |
|
|
1001
|
+
| im.v1.chat.create | [Create a group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create) | Create a group chat. When creating a group chat, you can set the group avatar, group name, group owner, group type and other configurations. You can also invite group members and group bots to join the group |
|
|
1002
|
+
| im.v1.chat.delete | [Delete a group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete) | Disband the specified group by chat_id. After disbanding the group through the API, the group chat history will not be saved |
|
|
1003
|
+
| im.v1.chat.get | [Obtain group information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get) | Obtains basic information such as group name, description, profile photo, and owner ID |
|
|
1004
|
+
| im.v1.chat.link | [Get group share link](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link) | Get the sharing link of the specified group. Others can join the group after clicking the sharing link |
|
|
1005
|
+
| im.v1.chat.list | [Obtain groups where the user or bot is a member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list) | Get the list of groups where the user or bot represented by [access_token] is a member |
|
|
1006
|
+
| im.v1.chatManagers.addManagers | [Specify group administrators](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/add_managers) | Specify a group and set the specified user or bot in the group as the group administrator |
|
|
1007
|
+
| im.v1.chatManagers.deleteManagers | [Delete group administrators](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-managers/delete_managers) | Specify a group and delete the specified administrator in the group, including user-type administrators and robot-type administrators |
|
|
1008
|
+
| im.v1.chatMembers.create | [Add users or bots to a group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create) | Adds users or bots into a group chat |
|
|
1009
|
+
| im.v1.chatMembers.delete | [Remove users or bots from a group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete) | Removes users or bots from a group chat |
|
|
1010
|
+
| im.v1.chatMembers.get | [Obtain group member list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get) | Get the list of members of the group the user/bot is in |
|
|
1011
|
+
| im.v1.chatMembers.isInChat | [Determine whether a user or bot is in a group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat) | Determines whether a user or bot is in a group based on their access_token |
|
|
1012
|
+
| im.v1.chatMembers.meJoin | [Users or bots join a group voluntarily](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join) | Add the operator (user or bot) currently calling the interface to the specified group chat |
|
|
1013
|
+
| im.v1.chatMenuItem.patch | [Patch chat menu item info](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_item/patch) | Patch the meta information of a top_level menu or second_level menu, including the icon, name, i18n name and redirect link of the chat menu |
|
|
1014
|
+
| im.v1.chatMenuTree.create | [Add chat menu](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/create) | Add one or more group menus to the specified group. After a successful call, the interface will return all group menu information in the current group |
|
|
1015
|
+
| im.v1.chatMenuTree.delete | [Delete chat menu](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/delete) | Delete the top level menu in the specified group. After a successful call, the interface will return the latest group menu information in the group |
|
|
1016
|
+
| im.v1.chatMenuTree.get | [Get chat menus](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/get) | Get the chat menu information in the specified group, including the names, jump links, icons and other information of all top level or second level menus |
|
|
1017
|
+
| im.v1.chatMenuTree.sort | [Sort chat menus](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-menu_tree/sort) | Adjust the order of group menus within the specified group. After a successful call, the interface will return all group menu information within the group |
|
|
1018
|
+
| im.v1.chatModeration.get | [Obtains the group member speech scopes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/get) | Obtains the group speech mode, the list of users who can speak, and more |
|
|
1019
|
+
| im.v1.chatModeration.update | [Updates group speech scopes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-moderation/update) | Update the speaking permissions of a specified group. You can set it to allow all group members to speak, only the group owner or administrator to speak, or specified group members to speak |
|
|
1020
|
+
| im.v1.chat.search | [Search for groups visible to a user or bot](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search) | Get the list of groups visible to the current identity (user or bot), including the groups the current identity belongs to and the groups that are open to the current identity. Supports keyword search and paged search |
|
|
1021
|
+
| im.v1.chatTab.create | [Add chat tab](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/create) | Add a custom chat tab in the specified chat. Only document type (doc) or URL type (url) tabs are supported |
|
|
1022
|
+
| im.v1.chatTab.deleteTabs | [Delete chat tab](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/delete_tabs) | Deletes one or more chat tabs within the specified chat |
|
|
1023
|
+
| im.v1.chatTab.listTabs | [Pull chat tabs](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/list_tabs) | Get the chat tab information in the specified chat, including ID, name, type, and content |
|
|
1024
|
+
| im.v1.chatTab.sortTabs | [Sort chat tab](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/sort_tabs) | Adjust the order of multiple chat tabs within a specified chat |
|
|
1025
|
+
| im.v1.chatTab.updateTabs | [Update chat tab](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-tab/update_tabs) | Updates the specified chat tab information, including name, type, and content. Only supports updating document type (doc) or URL type (url) tabs |
|
|
1026
|
+
| im.v1.chatTopNotice.deleteTopNotice | [Revoke group pinning](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/delete_top_notice) | Remove pinned messages or group announcements from a specified group |
|
|
1027
|
+
| im.v1.chatTopNotice.putTopNotice | [Update group pinning](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-top_notice/put_top_notice) | Updates the pinned information in a group chat. A group message or announcement can be pinned |
|
|
1028
|
+
| im.v1.chat.update | [Update group information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/update) | Update the information of the specified group, including group avatar, group name, group description, group configuration, and group owner, etc |
|
|
1029
|
+
| im.v1.message.create | [Send message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create) | Call this interface to send a message to a specified user or group chat. Supported message types include text, rich text, cards, group business cards, personal business cards, pictures, videos, audio, files, and emoticons |
|
|
1030
|
+
| im.v1.message.delete | [Recall message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete) | Call this interface to withdraw the specified message. Different identities (identity specified by the Authorization request header parameter) call the interface, and different effects can be achieved:- The robot can withdraw the message sent by the robot itself.- The group owner and administrator of the group chat can withdraw the specified message in the group |
|
|
1031
|
+
| im.v1.message.forward | [Forward a message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/forward) | Forwards a specified message to a user, group chat or thread |
|
|
1032
|
+
| im.v1.message.get | [Obtain the content of the specified message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/get) | Query message content with message_id |
|
|
1033
|
+
| im.v1.message.list | [Get chat history](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list) | Obtains chat history (chat records) of chats (including private chats and group chats) |
|
|
1034
|
+
| im.v1.message.mergeForward | [Merge forward messages](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/merge_forward) | Merge multiple messages from the same conversation and forward them to a specified user, group chat, or topic |
|
|
1035
|
+
| im.v1.message.patch | [Update sent message card](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/patch) | Call this interface to update the content of the specified message card by the message ID (message_id) |
|
|
1036
|
+
| im.v1.message.pushFollowUp | [Push follow-up](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/push_follow_up) | Call this interface to add bubble-style content below the latest message. When the message recipient clicks the bubble or a new message arrives, the bubble disappears |
|
|
1037
|
+
| im.v1.messageReaction.create | [Add a reaction for a message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create) | Adds a reaction of the specified type for a specified message |
|
|
1038
|
+
| im.v1.messageReaction.delete | [Delete a reaction for a message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete) | Deletes a reaction for a specified message |
|
|
1039
|
+
| im.v1.messageReaction.list | [List message reactions](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list) | Get the list of reactions in the specified message, and support getting only reactions of a specific type |
|
|
1040
|
+
| im.v1.message.readUsers | [Query the read status of message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users) | Query whether the specified message has been read. The interface only returns information about users who have read the message, not information about users who have not read the message |
|
|
1041
|
+
| im.v1.message.reply | [Reply message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/reply) | Call this interface to reply to a specified message. The reply content supports multiple types such as text, rich text, card, group business card, personal business card, picture, video, file, etc |
|
|
1042
|
+
| im.v1.message.update | [Edit message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/update) | Call this interface to edit the content of the sent message. It supports editing text and rich text messages. If you need to edit the card message, please use the [update the message card sent by the application] interface |
|
|
1043
|
+
| im.v1.message.urgentApp | [Send buzz messages in apps](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_app) | Call this interface to send the specified message buzz to the target user. Buzz is only notified in the Feishu client. For more information about buzz, please refer to [Buzz function] |
|
|
1044
|
+
| im.v1.message.urgentPhone | [Send buzz messages via phone call](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_phone) | Call this interface to buzz the specified message to the target user, and the buzz will be notified through the Feishu client and phone. For more information about buzz, please refer to [Buzz function] |
|
|
1045
|
+
| im.v1.message.urgentSms | [Send buzz messages via SMS](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/urgent_sms) | Call this interface to send the specified message buzz to the target user, and buzz will be notified through Feishu client and SMS. For more information about buzz, please refer to [Buzz function] |
|
|
1046
|
+
| im.v1.pin.create | [Pin a message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/create) | Pin a specified message. For the effects of Pin messages, see [Pin overview] |
|
|
1047
|
+
| im.v1.pin.delete | [Unpin a message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/delete) | Remove the pin of a specified message |
|
|
1048
|
+
| im.v1.pin.list | [Get pins in group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/pin/list) | Get all pin data within the specified time range in the chat |
|
|
1049
|
+
| im.v1.thread.forward | [Forward a thread](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/thread/forward) | Forward a thread to a user, group, or thread |
|
|
1050
|
+
|
|
1051
|
+
## Business domain: imV2
|
|
1052
|
+
| MCP Tool Name | API | Description |
|
|
1053
|
+
| --- | --- | --- |
|
|
1054
|
+
| im.v2.appFeedCardBatch.delete | [Delete app feed card](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/delete) | This interface is used to delete application information flow cards |
|
|
1055
|
+
| im.v2.appFeedCardBatch.update | [Update app feed card](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card-batch/update) | This interface is used to update the avatar, title, preview, label status, button and other information of the information flow card |
|
|
1056
|
+
| im.v2.appFeedCard.create | [Create app feed card](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/app_feed_card/create) | The app feed card is a tool that allows applications to directly send messages within the feed list, ensuring that important messages reach users more quickly |
|
|
1057
|
+
| im.v2.bizEntityTagRelation.create | [Bind tags with business entities](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/create) | Bind tags with biz entity. Currently, tagging for chat is supported |
|
|
1058
|
+
| im.v2.bizEntityTagRelation.get | [queryTagsBindOnEntity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/get) | query tags bind on entity |
|
|
1059
|
+
| im.v2.bizEntityTagRelation.update | [Unbind tags from a business entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/biz_entity_tag_relation/update) | Unbind tags from biz entity |
|
|
1060
|
+
| im.v2.chatButton.update | [Update feed card button](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/chat_button/update) | You can add shortcut operation buttons, update buttons, or delete buttons to Groups & Bots feed card |
|
|
1061
|
+
| im.v2.feedCard.botTimeSentive | [Bot chat instant reminder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/bot_time_sentive) | users can use the bot chat instant reminder capability to display robot conversations at the top of the message list. Open Feishu. Tackle important tasks right from the first page of the book |
|
|
1062
|
+
| im.v2.feedCard.patch | [Instant reminder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/feed_card/patch) | The instant reminder capability is a strong reminder capability provided by Feishu in the message list. When there are important notifications or tasks that need to be reached in time, users can use the instant reminder capability to display group or robot conversations at the top of the message list. Open Feishu. Tackle important tasks right from the first page of the book |
|
|
1063
|
+
| im.v2.tag.create | [Create a tag](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/create) | Create a tag. The tag ID will be returned |
|
|
1064
|
+
| im.v2.tag.patch | [Update a tag](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/tag/patch) | Modify the name of the tag in different languages |
|
|
1065
|
+
| im.v2.urlPreview.batchUpdate | [Update URL preview](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/group/im-v2/url_preview/batch_update) | Actively update the [URL preview]. After the call, the client pull will be triggered again, and the callback service needs to return the updated data |
|
|
1066
|
+
|
|
1067
|
+
## Business domain: lingoV1
|
|
1068
|
+
| MCP Tool Name | API | Description |
|
|
1069
|
+
| --- | --- | --- |
|
|
1070
|
+
| lingo.v1.classification.list | [Classification list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/classification/list) | Get Lingo classification data, Baike currently supports primary classification and sub-classification, temporarily does not support multi-level classification |
|
|
1071
|
+
| lingo.v1.draft.create | [Create draft](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/draft/create) | Draft is not an entry, but an application to create a new entry or update an existing entry through the API.After the dictionary administrator approves it, the draft will become a new entry or overwrite an existing entry |
|
|
1072
|
+
| lingo.v1.draft.update | [Update draft](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/draft/update) | The draft content is updated according to the draft_id, and the approved draft cannot be edited |
|
|
1073
|
+
| lingo.v1.entity.create | [Create an exemption entry](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/create) | Create the existing entries through this interface, do not need Lingo a moderator review can be written directly to the thesaurus, please use carefully [tenant moderator please review carefully |
|
|
1074
|
+
| lingo.v1.entity.delete | [Delete the exemption entry](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/delete) | Delete the existing entries by entity_id, do not need Lingo moderator review, please use carefully [tenant moderator please review carefully] |
|
|
1075
|
+
| lingo.v1.entity.get | [Get entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/get) | Pull the corresponding entity details through the entity id |
|
|
1076
|
+
| lingo.v1.entity.highlight | [Highlight entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/highlight) | The user passes in a sentence and returns the position and corresponding Id of the entity word, allowing the user to highlight the entity word |
|
|
1077
|
+
| lingo.v1.entity.list | [Get entities](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/list) | Paging entity word data to support all entity word pulling within the tenant |
|
|
1078
|
+
| lingo.v1.entity.match | [Match entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/match) | Accurately match the keyword with the entry name and alias, and return the corresponding entry ID |
|
|
1079
|
+
| lingo.v1.entity.search | [Search entity](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/search) | Passing in keywords, performing fuzzy matching to search for corresponding entity words |
|
|
1080
|
+
| lingo.v1.entity.update | [Update the exemption entry](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/update) | Update the existing entries through this interface, do not need Lingo moderator review can be written directly to the thesaurus, please use carefully [tenant moderator please review carefully] |
|
|
1081
|
+
| lingo.v1.repo.list | [repo list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/repo/list) | get the list of lingo repos that you have permission to access. To obtain as an application, you need to add an application on the lingo admin console; If obtaining as a user, the user needs to have visible permissions for the repo |
|
|
1082
|
+
|
|
1083
|
+
## Business domain: mailV1
|
|
1084
|
+
| MCP Tool Name | API | Description |
|
|
1085
|
+
| --- | --- | --- |
|
|
1086
|
+
| mail.v1.mailgroupAlias.create | [Create A Mailing List Alias](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/create) | Creates a mailing list alias |
|
|
1087
|
+
| mail.v1.mailgroupAlias.delete | [Delete A Mailing List Alias](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/delete) | Deletes a mailing list alias |
|
|
1088
|
+
| mail.v1.mailgroupAlias.list | [Obtain All Mailing List Aliases](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/list) | Obtains all mailing list aliases |
|
|
1089
|
+
| mail.v1.mailgroup.create | [Create Mail Group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/create) | Creates a mailing list |
|
|
1090
|
+
| mail.v1.mailgroup.delete | [Delete Mail Group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/delete) | Deletes a mailing list |
|
|
1091
|
+
| mail.v1.mailgroup.get | [Query The Specified Mail Group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/get) | Obtains the information of a mailing list |
|
|
1092
|
+
| mail.v1.mailgroup.list | [Obtain Mailing Lists In Batch](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list) | Obtains mailing lists by pages |
|
|
1093
|
+
| mail.v1.mailgroupManager.batchCreate | [Create Mailing List Managers In Batch](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create) | Adds managers to a mailing list |
|
|
1094
|
+
| mail.v1.mailgroupManager.batchDelete | [Batch Delete Mail Group Managers](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_delete) | Batch delete mail group managers |
|
|
1095
|
+
| mail.v1.mailgroupManager.list | [Obtain Mailing List Managers In Batch](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list) | Obtains the list of mailing list managers by pages |
|
|
1096
|
+
| mail.v1.mailgroupMember.batchCreate | [Batch Create Mail Group Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create) | You can add multiple members to a mail group at a time |
|
|
1097
|
+
| mail.v1.mailgroupMember.batchDelete | [Batch Delete Mail Group Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_delete) | Multiple members of a mail group can be deleted in one request |
|
|
1098
|
+
| mail.v1.mailgroupMember.create | [Create A Mailing List Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create) | Adds a member to a mailing list |
|
|
1099
|
+
| mail.v1.mailgroupMember.delete | [Delete A Mailing List Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/delete) | Deletes a mailing list member |
|
|
1100
|
+
| mail.v1.mailgroupMember.get | [Obtain Mailing List Member Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/get) | Obtains the information of a mailing list member |
|
|
1101
|
+
| mail.v1.mailgroupMember.list | [Obtain Mailing List Members In Batch](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list) | Obtains the list of mailing list members by pages |
|
|
1102
|
+
| mail.v1.mailgroup.patch | [Modify Some Information Of Mail Group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/patch) | Updates some fields of a mailing list. The fields not specified are not updated |
|
|
1103
|
+
| mail.v1.mailgroupPermissionMember.batchCreate | [Batch Create Mail Group Permission Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create) | A single request can add multiple permission members to a mail group |
|
|
1104
|
+
| mail.v1.mailgroupPermissionMember.batchDelete | [Batch Delete Mail Group Permission Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_delete) | A single request can delete multiple permission members in a mail group |
|
|
1105
|
+
| mail.v1.mailgroupPermissionMember.create | [Create A Mail Group Permission Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/create) | Adds a member with custom permission to the mailing list, who will then be able to send emails to this mailing list |
|
|
1106
|
+
| mail.v1.mailgroupPermissionMember.delete | [Delete A Mail Group Permission Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/delete) | Deletes a member with custom permission, who will then be unable to send emails to this mailing list |
|
|
1107
|
+
| mail.v1.mailgroupPermissionMember.get | [Get A Mail Group Permission Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/get) | Obtains the information of a member who can send emails to mailing list addresses |
|
|
1108
|
+
| mail.v1.mailgroupPermissionMember.list | [List Permission Members Of A Mail Group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list) | Obtains the list of members who can send emails to mailing list addresses by pages |
|
|
1109
|
+
| mail.v1.mailgroup.update | [Modify All Information Of Mail Group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/update) | Updates all information of a mailing list |
|
|
1110
|
+
| mail.v1.publicMailboxAlias.create | [Create A Public Mailbox Alias](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/create) | Creates a public mailbox alias |
|
|
1111
|
+
| mail.v1.publicMailboxAlias.delete | [Delete A Public Mailbox Alias](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/delete) | Deletes a public mailbox alias |
|
|
1112
|
+
| mail.v1.publicMailboxAlias.list | [Obtain All Public Mailbox Aliases](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/list) | Obtains all public mailbox aliases |
|
|
1113
|
+
| mail.v1.publicMailbox.create | [Create A Public Mailbox](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/create) | Creates a public mailbox |
|
|
1114
|
+
| mail.v1.publicMailbox.delete | [Permanently Delete Public Mailbox Address](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete) | Releases a public mailbox address from the email recycle bin. This deletes a public mailbox address forever, which means the mailbox address cannot be recovered once deleted |
|
|
1115
|
+
| mail.v1.publicMailbox.get | [Query The Specified Public Mailbox](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/get) | Obtains public mailbox information |
|
|
1116
|
+
| mail.v1.publicMailbox.list | [Check All Public Mailboxes](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list) | Obtains the list of public mailboxes by pages |
|
|
1117
|
+
| mail.v1.publicMailboxMember.batchCreate | [Batch Create Public Mailbox Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create) | A single request can add multiple members to a public mailbox |
|
|
1118
|
+
| mail.v1.publicMailboxMember.batchDelete | [Batch Delete Public Mailbox Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_delete) | A single request can delete multiple members of a public mailbox |
|
|
1119
|
+
| mail.v1.publicMailboxMember.clear | [Clear Public Mailbox Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/clear) | Deletes all members of a public mailbox |
|
|
1120
|
+
| mail.v1.publicMailboxMember.create | [Create A Public Mailbox Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/create) | Adds a member to a public mailbox |
|
|
1121
|
+
| mail.v1.publicMailboxMember.delete | [Delete A Public Mailbox Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/delete) | Deletes a member of a public mailbox |
|
|
1122
|
+
| mail.v1.publicMailboxMember.get | [Get A Public Mailbox Member](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/get) | Obtains the information of a public mailbox member |
|
|
1123
|
+
| mail.v1.publicMailboxMember.list | [List Public Mailbox Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list) | Obtains the list of public mailbox members by pages |
|
|
1124
|
+
| mail.v1.publicMailbox.patch | [Modify Some Information Of Public Mailbox](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/patch) | Updates some fields of a public mailbox. The fields not specified are not updated |
|
|
1125
|
+
| mail.v1.publicMailbox.removeToRecycleBin | [Move Public Mailbox To The Recycle Bin](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/remove_to_recycle_bin) | Move Public Mailbox To The Recycle Bin |
|
|
1126
|
+
| mail.v1.publicMailbox.update | [Modify All Information Of Public Mailbox](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/update) | Updates all information of a public mailbox |
|
|
1127
|
+
| mail.v1.userMailboxAlias.create | [Create A Member's Email Alias](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/create) | Creates a member's email alias |
|
|
1128
|
+
| mail.v1.userMailboxAlias.delete | [Delete A Member's Email Alias](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/delete) | Deletes a member's email alias |
|
|
1129
|
+
| mail.v1.userMailboxAlias.list | [Obtain All Member's Email Aliases](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/list) | Obtains all member's email aliases |
|
|
1130
|
+
| mail.v1.userMailbox.delete | [Release Address From Recycle Bin](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox/delete) | Deletes a member's email address from the email recycle bin. This deletes a member's email address forever, which means the email address cannot be recovered once deleted. This API also allows you to transfer emails from the mailbox to be released to another mailbox |
|
|
1131
|
+
| mail.v1.userMailboxEvent.subscribe | [Subscribe Event](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-event/subscribe) | Subscribe Event |
|
|
1132
|
+
| mail.v1.userMailboxEvent.subscription | [Get Subscription Status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-event/subscription) | Get Subscription Status |
|
|
1133
|
+
| mail.v1.userMailboxEvent.unsubscribe | [Cancel Subscribe](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-event/unsubscribe) | Cancel Subscribe |
|
|
1134
|
+
| mail.v1.userMailboxFolder.create | [Create Email Folder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/create) | Create Email Folder |
|
|
1135
|
+
| mail.v1.userMailboxFolder.delete | [Delete Email Folder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/delete) | Delete Email Folder |
|
|
1136
|
+
| mail.v1.userMailboxFolder.list | [List Email Folders](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/list) | List Email Folders |
|
|
1137
|
+
| mail.v1.userMailboxFolder.patch | [Update Email Folder](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/patch) | Update Email Folder |
|
|
1138
|
+
| mail.v1.userMailboxMailContact.create | [Create Email Contact](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/create) | Create A Email Contact |
|
|
1139
|
+
| mail.v1.userMailboxMailContact.delete | [Delete Email Contact](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/delete) | Delete An Email Contact |
|
|
1140
|
+
| mail.v1.userMailboxMailContact.list | [List Email Contacts](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/list) | List Email Contacts |
|
|
1141
|
+
| mail.v1.userMailboxMailContact.patch | [Modify Email Contact's Info](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/patch) | When using the tenant_access_token, it is necessary to apply for data permissions for accessing email contacts resources |
|
|
1142
|
+
| mail.v1.userMailboxMessageAttachment.downloadUrl | [Get Attachment Download Links](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message-attachment/download_url) | Get Attachment Download Links |
|
|
1143
|
+
| mail.v1.userMailboxMessage.get | [Get Email Details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/get) | Get Email Details |
|
|
1144
|
+
| mail.v1.userMailboxMessage.getByCard | [list mail of card](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/get_by_card) | list mail of mail card |
|
|
1145
|
+
| mail.v1.userMailboxMessage.list | [List Emails](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/list) | List Emails |
|
|
1146
|
+
| mail.v1.userMailboxMessage.send | [Send Message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/send) | Send Message |
|
|
1147
|
+
| mail.v1.userMailboxRule.create | [Create Auto FIlter](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/create) | Create Auto Filter |
|
|
1148
|
+
| mail.v1.userMailboxRule.delete | [Delete Auto Filter](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/delete) | Delete Auto Filter |
|
|
1149
|
+
| mail.v1.userMailboxRule.list | [List Auto FIlters](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/list) | List Auto Filters |
|
|
1150
|
+
| mail.v1.userMailboxRule.reorder | [Reorder Auto Filters](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/reorder) | Reorder Auto Filters |
|
|
1151
|
+
| mail.v1.userMailboxRule.update | [Update Auto FIlter](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/update) | Update Auto Filter |
|
|
1152
|
+
| mail.v1.user.query | [Email Address Query](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user/query) | Using the query API, you can enter an email address to query the type and status corresponding to the email address |
|
|
1153
|
+
|
|
1154
|
+
## Business domain: mdmV1
|
|
1155
|
+
| MCP Tool Name | API | Description |
|
|
1156
|
+
| --- | --- | --- |
|
|
1157
|
+
| mdm.v1.userAuthDataRelation.bind | [User data dimension binding](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/bind) | Through this interface, a type of data dimension can be bound to users under a specified application, and batch authorization can be granted to multiple users at the same time |
|
|
1158
|
+
| mdm.v1.userAuthDataRelation.unbind | [User data dimension unbinding](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/unbind) | Through this interface, a type of data dimension can be released for a specified user under a specified application |
|
|
1159
|
+
|
|
1160
|
+
## Business domain: mdmV3
|
|
1161
|
+
| MCP Tool Name | API | Description |
|
|
1162
|
+
| --- | --- | --- |
|
|
1163
|
+
| mdm.v3.batchCountryRegion.get | [batch get major by id](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v3/batch_country_region/get) | Batch Get Country Region By ID |
|
|
1164
|
+
| mdm.v3.countryRegion.list | [Pagination Batch Query Country Region](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v3/country_region/list) | Paging batch query country region |
|
|
1165
|
+
|
|
1166
|
+
## Business domain: minutesV1
|
|
1167
|
+
| MCP Tool Name | API | Description |
|
|
1168
|
+
| --- | --- | --- |
|
|
1169
|
+
| minutes.v1.minute.get | [Get minutes meta](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute/get) | Through this api, you can get a basic overview of Lark Minutes, including `owner_id`, `create_time`, title, cover picture, duration and URL |
|
|
1170
|
+
| minutes.v1.minuteMedia.get | [Download minutes audio or video file](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-media/get) | Get the audio or video file of minutes |
|
|
1171
|
+
| minutes.v1.minuteStatistics.get | [Get minutes statistics](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-statistics/get) | Through this API, you can get access statistics of Feishu Minutes, including PV, UV, visited user id, visited user timestamp |
|
|
1172
|
+
|
|
1173
|
+
## Business domain: momentsV1
|
|
1174
|
+
| MCP Tool Name | API | Description |
|
|
1175
|
+
| --- | --- | --- |
|
|
1176
|
+
| moments.v1.post.get | [Query post information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/moments-v1/post/get) | Query post entity data information by post id |
|
|
1177
|
+
|
|
1178
|
+
## Business domain: okrV1
|
|
1179
|
+
| MCP Tool Name | API | Description |
|
|
1180
|
+
| --- | --- | --- |
|
|
1181
|
+
| okr.v1.okr.batchGet | [Get OKR in bulk](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/okr/batch_get) | Get OKR in batches based on OKR id |
|
|
1182
|
+
| okr.v1.periodRule.list | [Get OKR period rules](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list) | Get a list of periodic rules for your tenant |
|
|
1183
|
+
| okr.v1.period.create | [Create OKR period](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create) | Creare a OKR period according to given period rule |
|
|
1184
|
+
| okr.v1.period.list | [Get the OKR cycle list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list) | Get the OKR cycle list |
|
|
1185
|
+
| okr.v1.period.patch | [Modify OKR period status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch) | Modify a OKR period's status to 'Normal', 'Invalid' or 'Hidden'. This apply on every user in your tenant, please take caution |
|
|
1186
|
+
| okr.v1.progressRecord.create | [Create OKR progress record](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create) | Create OKR progress record |
|
|
1187
|
+
| okr.v1.progressRecord.delete | [Delete OKR progress](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete) | Delete OKR progress |
|
|
1188
|
+
| okr.v1.progressRecord.get | [Get OKR progress records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get) | Obtain OKR progress record details according to ID |
|
|
1189
|
+
| okr.v1.progressRecord.update | [Update OKR progress](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update) | Update OKR progress |
|
|
1190
|
+
| okr.v1.review.query | [Query review information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query) | According to the cycle and user query review information |
|
|
1191
|
+
| okr.v1.userOkr.list | [Get the user's OKR list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list) | Get OKR list based on user id |
|
|
1192
|
+
|
|
1193
|
+
## Business domain: opticalCharRecognitionV1
|
|
1194
|
+
| MCP Tool Name | API | Description |
|
|
1195
|
+
| --- | --- | --- |
|
|
1196
|
+
| optical_char_recognition.v1.image.basicRecognize | [Recognize text in pictures](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize) | Basic picture recognition interface, recognize the text in the picture, and return the text list by area.File size must be less than 5M |
|
|
1197
|
+
|
|
1198
|
+
## Business domain: passportV1
|
|
1199
|
+
| MCP Tool Name | API | Description |
|
|
1200
|
+
| --- | --- | --- |
|
|
1201
|
+
| passport.v1.session.logout | [Log out](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/logout) | This interface is used to log out of the user login state |
|
|
1202
|
+
| passport.v1.session.query | [Obtain desensitized user login information in batches](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/query) | This interface is used to query the user's login information |
|
|
1203
|
+
|
|
1204
|
+
## Business domain: payrollV1
|
|
1205
|
+
| MCP Tool Name | API | Description |
|
|
1206
|
+
| --- | --- | --- |
|
|
1207
|
+
| payroll.v1.costAllocationDetail.list | [query details on cost allocation reports](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_detail/list) | Obtain detailed cost allocation data based on report plan, period and report type. Before invoking the interface, the "financial Posting" switch should be turned on and the cost allocation report should be published |
|
|
1208
|
+
| payroll.v1.costAllocationPlan.list | [Get Cost Plans](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_plan/list) | Get Cost Plans |
|
|
1209
|
+
| payroll.v1.costAllocationReport.list | [Batch Get Cost Reports](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_report/list) | Batch Get Cost Reports |
|
|
1210
|
+
| payroll.v1.datasourceRecord.query | [query datasource records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource_record/query) | 1. Support through payroll_period (required), employment_id (optional) these two preset fields, batch query the data record list under the specified data source.2. The data source configuration information can be obtained from the [list datasource configs] or "Feishu Personnel Background - Settings - Salary Data Settings - External Data Source Configuration" page |
|
|
1211
|
+
| payroll.v1.datasourceRecord.save | [save datasource records](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource_record/save) | Refer to the data source configuration field format to save (create or update) data records in batches.1. The unique flag of the record is judged by the business primary key (employment_id + payroll_period)2. If there is no data record, 1 record will be inserted into this save.3. If a data record already exists, this save will overwrite and update the existing record (only the value of the incoming field is updated, and the value of the unpassed field is not updated). If the incoming data record has not changed, it will not be updated.4. If the update or insertion is successful, the number of records that have changed the data will be returned |
|
|
1212
|
+
| payroll.v1.datasource.list | [list datasource configs](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/datasource/list) | Batch query Feishu personnel background: Settings - > Salary data settings - > External data source settings, the list of data source settings in |
|
|
1213
|
+
|
|
1214
|
+
## Business domain: performanceV1
|
|
1215
|
+
| MCP Tool Name | API | Description |
|
|
1216
|
+
| --- | --- | --- |
|
|
1217
|
+
| performance.v1.reviewData.query | [Get performance result](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/review_data/query) | Get performance result |
|
|
1218
|
+
| performance.v1.semester.list | [Obtain cycle](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/semester/list) | Obtain basic information about the cycle |
|
|
1219
|
+
| performance.v1.stageTask.findByPage | [Obtain Cycle Tasks (all users)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_page) | Get task information for all users |
|
|
1220
|
+
| performance.v1.stageTask.findByUserList | [Obtain Cycle Tasks (specified users)](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v1/stage_task/find_by_user_list) | Get task information for specified users |
|
|
1221
|
+
|
|
1222
|
+
## Business domain: performanceV2
|
|
1223
|
+
| MCP Tool Name | API | Description |
|
|
1224
|
+
| --- | --- | --- |
|
|
1225
|
+
| performance.v2.activity.query | [Get information about the project](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/activity/query) | Obtain project information, such as project name, project model, etc |
|
|
1226
|
+
| performance.v2.additionalInformation.import | [Batch Import Supplementary Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/import) | Supplementary information of the reviewees can be imported in batches for review reference (including both new additions and updates) |
|
|
1227
|
+
| performance.v2.additionalInformation.query | [Batch Query Supplementary Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_information/query) | Supplementary information of the reviewees can be queried in batches |
|
|
1228
|
+
| performance.v2.additionalInformationsBatch.delete | [Batch Delete Supplementary Information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/additional_informations-batch/delete) | Supplementary information of the reviewees can be deleted in batches |
|
|
1229
|
+
| performance.v2.indicator.query | [Get the evaluation question configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/indicator/query) | Get scoring queations |
|
|
1230
|
+
| performance.v2.metricDetail.import | [Batch entry of key metrics details of the person being evaluated for the specified period](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_detail/import) | Batch entry of key metrics details of the person being evaluated in the specified period |
|
|
1231
|
+
| performance.v2.metricDetail.query | [Batch acquisition of key metric details of the person being evaluated for the specified period](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_detail/query) | Batch acquisition of key metric details of the person being evaluated in the specified period |
|
|
1232
|
+
| performance.v2.metricField.query | [Get indicator field information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_field/query) | Get the field base information of the indicator |
|
|
1233
|
+
| performance.v2.metricLib.query | [Get indicator library information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_lib/query) | Get information on the indicator library |
|
|
1234
|
+
| performance.v2.metricTag.list | [Get metric tag information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_tag/list) | Get metric tag information. Such as the name of the metric tag, the create time of metric tag |
|
|
1235
|
+
| performance.v2.metricTemplate.query | [Get indicator template information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/metric_template/query) | Get information on the indicator template |
|
|
1236
|
+
| performance.v2.question.query | [Get evaluation template configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/question/query) | Get tag-based questions |
|
|
1237
|
+
| performance.v2.reviewData.query | [Acquire detailed performance data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_data/query) | Get performance details (excluding calibration) |
|
|
1238
|
+
| performance.v2.reviewTemplate.query | [Get label fill in question configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/review_template/query) | Get review templates |
|
|
1239
|
+
| performance.v2.reviewee.query | [Obtain information of reviewees](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/reviewee/query) | Obtain information of individuals selected for projects (including uninitiated projects) during the performance cycle |
|
|
1240
|
+
| performance.v2.userGroupUserRel.write | [Write member scope of individual group](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/user_group_user_rel/write) | Write member scope of individual group |
|
|
1241
|
+
|
|
1242
|
+
## Business domain: personalSettingsV1
|
|
1243
|
+
| MCP Tool Name | API | Description |
|
|
1244
|
+
| --- | --- | --- |
|
|
1245
|
+
| personal_settings.v1.systemStatus.batchClose | [Batch close system status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_close) | Batch close user system status available |
|
|
1246
|
+
| personal_settings.v1.systemStatus.batchOpen | [Batch open system status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open) | Batch open user system status is available |
|
|
1247
|
+
| personal_settings.v1.systemStatus.create | [Create system status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/create) | Create a system status with a tenant-wide dimension |
|
|
1248
|
+
| personal_settings.v1.systemStatus.delete | [Delete system status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/delete) | Delete a system status of the full-tenant dimension |
|
|
1249
|
+
| personal_settings.v1.systemStatus.list | [List system status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list) | List system statuses with a tenant-wide dimension |
|
|
1250
|
+
| personal_settings.v1.systemStatus.patch | [Patch system status](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/patch) | Patch a system state with a tenant-wide dimension |
|
|
1251
|
+
|
|
1252
|
+
## Business domain: reportV1
|
|
1253
|
+
| MCP Tool Name | API | Description |
|
|
1254
|
+
| --- | --- | --- |
|
|
1255
|
+
| report.v1.rule.query | [Query rules](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule/query) | Query rules |
|
|
1256
|
+
| report.v1.ruleView.remove | [Remove rule board](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule-view/remove) | Remove rule board |
|
|
1257
|
+
| report.v1.task.query | [Query tasks](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query) | Query tasks |
|
|
1258
|
+
|
|
1259
|
+
## Business domain: searchV2
|
|
1260
|
+
| MCP Tool Name | API | Description |
|
|
1261
|
+
| --- | --- | --- |
|
|
1262
|
+
| search.v2.app.create | [Search app](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/app/create) | users can search for visible applications by keyword, and the visibility of applications is consistent with the search in the suite |
|
|
1263
|
+
| search.v2.dataSource.create | [Create data source](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/create) | Search-Search Connector-Data source-Create data source |
|
|
1264
|
+
| search.v2.dataSource.delete | [Delete data source](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/delete) | Search-Search Connector-Data source-Delete data source |
|
|
1265
|
+
| search.v2.dataSource.get | [Get data source](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/get) | Search-Search Connector-Data source-Get data source |
|
|
1266
|
+
| search.v2.dataSourceItem.create | [Index data item](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/create) | Search-Search Connector-Data item-Index data item |
|
|
1267
|
+
| search.v2.dataSourceItem.delete | [Delete data item](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/delete) | Search-Search Connector-Data item-Delete data item |
|
|
1268
|
+
| search.v2.dataSourceItem.get | [Get data item](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source-item/get) | Get a single data record |
|
|
1269
|
+
| search.v2.dataSource.list | [Batch get data sources](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/list) | Search-Search Connector-Data source-Batch get data sources |
|
|
1270
|
+
| search.v2.dataSource.patch | [Modify data source](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/data_source/patch) | Search-Search Connector-Data source-Modify data source |
|
|
1271
|
+
| search.v2.message.create | [search message](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/message/create) | Users can search for visible messages by keyword, and the visibility is consistent with the search in the suite |
|
|
1272
|
+
| search.v2.schema.create | [Create data schema](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/create) | Search-Search Connector-Data schema-Create data schema |
|
|
1273
|
+
| search.v2.schema.delete | [Delete data schema](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/delete) | Search-Search Connector-Data schema-Delete data schema |
|
|
1274
|
+
| search.v2.schema.get | [Get data schema](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/get) | Search-Search Connector-Data schema-Get data schema |
|
|
1275
|
+
| search.v2.schema.patch | [Modify data schema](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/search-v2/schema/patch) | Search-Search Connector-Data schema-Modify data schema |
|
|
1276
|
+
|
|
1277
|
+
## Business domain: securityAndComplianceV1
|
|
1278
|
+
| MCP Tool Name | API | Description |
|
|
1279
|
+
| --- | --- | --- |
|
|
1280
|
+
| security_and_compliance.v1.openapiLog.listData | [Obtain OpenAPI audit log](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v1/openapi_log/list_data) | This api is used to obtain OpenAPI audit log |
|
|
1281
|
+
|
|
1282
|
+
## Business domain: sheetsV2
|
|
1283
|
+
| MCP Tool Name | API | Description |
|
|
1284
|
+
| --- | --- | --- |
|
|
1285
|
+
| sheets.v2.spreadsheetValues.get | [Read a single range](https://open.feishu.cn/document/ukTMukTMukTM/ugTMzUjL4EzM14COxMTN) | Read cell values from a specified range in a spreadsheet. The range format is sheet_id!A1:B2 or just A1:B2 for the first sheet |
|
|
1286
|
+
| sheets.v2.spreadsheetValues.batchGet | [Read multiple ranges](https://open.feishu.cn/document/ukTMukTMukTM/ukTMzUjL5EzM14SOxMTN) | Read cell values from multiple specified ranges in a spreadsheet |
|
|
1287
|
+
| sheets.v2.spreadsheetValues.update | [Write to a single range](https://open.feishu.cn/document/ukTMukTMukTM/uAjMzUjLwIzM14CMyMTN) | Write values to a specified range in a spreadsheet. Values will overwrite existing data |
|
|
1288
|
+
| sheets.v2.spreadsheetValues.batchUpdate | [Write to multiple ranges](https://open.feishu.cn/document/ukTMukTMukTM/uEjMzUjLxIzM14SMyMTN) | Write values to multiple specified ranges in a spreadsheet |
|
|
1289
|
+
| sheets.v2.spreadsheetValues.append | [Append data](https://open.feishu.cn/document/ukTMukTMukTM/uMjMzUjLzIzM14yMyMTN) | Append values after the last row with data in the specified range |
|
|
1290
|
+
| sheets.v2.spreadsheetDimensionRange.insert | [Insert rows or columns](https://open.feishu.cn/document/ukTMukTMukTM/uQjMzUjL0IzM14CNyMTN) | Insert empty rows or columns at the specified position in a sheet |
|
|
1291
|
+
| sheets.v2.spreadsheetDimensionRange.delete | [Delete rows or columns](https://open.feishu.cn/document/ukTMukTMukTM/uUjMzUjL1IzM14SNyMTN) | Delete rows or columns at the specified position in a sheet |
|
|
1292
|
+
|
|
1293
|
+
## Business domain: sheetsV3
|
|
1294
|
+
| MCP Tool Name | API | Description |
|
|
1295
|
+
| --- | --- | --- |
|
|
1296
|
+
| sheets.v3.spreadsheet.create | [Create a spreadsheet](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/create) | Use this API to create an online spreadsheet under the specified directory. The table title can be customized. Creating forms with content is not supported |
|
|
1297
|
+
| sheets.v3.spreadsheet.get | [Get spreadsheet information](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/get) | This interface is used to obtain basic information for the spreadsheet, including the owner of the spreadsheet, URL links, and other related details |
|
|
1298
|
+
| sheets.v3.spreadsheet.patch | [Modify spreadsheet properties](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/patch) | This interface is used to modify the properties of the spreadsheet. Currently, modifying spreadsheet titles is supported |
|
|
1299
|
+
| sheets.v3.spreadsheetSheetFilterViewCondition.create | [Create Filter Condition](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/create) | ::: noteFor filter conditions, see [User guide for using filter conditions in the filter view]:::This API is used to create filter conditions for a column in the range of a filter view |
|
|
1300
|
+
| sheets.v3.spreadsheetSheetFilterViewCondition.delete | [Delete Filter Condition](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/delete) | This API is used to delete filter conditions for a specified column in the range of a filter view |
|
|
1301
|
+
| sheets.v3.spreadsheetSheetFilterViewCondition.get | [Obtain Filter Condition](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/get) | ::: noteFor filter condition explanations, see [User guide for using filter conditions in the filter view]:::This API is used to obtain the filter conditions of a specified column in the filter view |
|
|
1302
|
+
| sheets.v3.spreadsheetSheetFilterViewCondition.query | [Query Filter Condition](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/query) | ::: noteFor filter condition explanations, see [User guide for using filter conditions in the filter view]:::This API is used to query all filter conditions of a filter view. All filter conditions in the range of the filter view are returned |
|
|
1303
|
+
| sheets.v3.spreadsheetSheetFilterViewCondition.update | [Update Filter Condition](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/update) | ::: noteFor filter condition parameters, see [User guide for using filter conditions in the filter view]:::This API is used to update filter conditions for a column in the range of a filter view. The condition ID is the letter designation of the column |
|
|
1304
|
+
| sheets.v3.spreadsheetSheetFilterView.create | [Create Filter View](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/create) | ::: noteFor range settings, see: [User guide for using filter conditions in the filter view]:::This API is used to create a filter view based on passed in parameters. The ID and name fields are optional and default values are generated if none are provided. The range field is required. IDs are 10 characters long and composed of numbers and upper and lowercase English letters. Names can't exceed 100 characters. A single sheet can have up to 150 filter views |
|
|
1305
|
+
| sheets.v3.spreadsheetSheetFilterView.delete | [Delete Filter View](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/delete) | This API is used to delete the filter view corresponding to the specified ID |
|
|
1306
|
+
| sheets.v3.spreadsheetSheetFilterView.get | [Obtain Filter View](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/get) | This API is used to obtain the name and range of a specified filter view ID |
|
|
1307
|
+
| sheets.v3.spreadsheetSheetFilterView.patch | [Update Filter View](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/patch) | ::: noteFor range settings, see: [User guide for using filter conditions in the filter view]:::This API is used to update the filter view name or range. The name can't exceed 100 characters and must be unique within the sheet. The range can't exceed the maximum range of the sheet |
|
|
1308
|
+
| sheets.v3.spreadsheetSheetFilterView.query | [Query Filter View](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/query) | This API is used to query the basic information of all filter views in a sheet, including their IDs, names, and ranges |
|
|
1309
|
+
| sheets.v3.spreadsheetSheetFilter.create | [Create Filter](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/create) | ::: noteFor parameter values, see [Filter guide]:::This API is used to create a filter in a sheet |
|
|
1310
|
+
| sheets.v3.spreadsheetSheetFilter.delete | [Delete Filter](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/delete) | This API is used to delete the filter of a sheet |
|
|
1311
|
+
| sheets.v3.spreadsheetSheetFilter.get | [Obtain Filter](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/get) | This API is used to obtain the filter details for a sheet |
|
|
1312
|
+
| sheets.v3.spreadsheetSheetFilter.update | [Update Filter](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/update) | ::: noteFor parameter values, see [Filter guide]:::This API is used to update column filter conditions in the sheet range |
|
|
1313
|
+
| sheets.v3.spreadsheetSheet.find | [Find cells](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/find) | 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 |
|
|
1314
|
+
| sheets.v3.spreadsheetSheetFloatImage.create | [Create Floating Image](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/create) | ::: noteFor information about the settings of a floating image, see [Floating image guide].:::This API is used to create a floating image based on the parameters passed in. Float_image_token ([obtained after uploading an image to a spreadsheet]) and range (only one cell) are required parameters. Float_image_id is optional, and a default ID is generated if this field is not specified. IDs are 10 characters long and composed of numbers (0-9) and upper and lowercase English letters. A spreadsheet cannot have duplicate images, and the total of floating images and cell images cannot exceed 4,000. The width and height specify the display width and height of an image, which are optional. If not specified, the image is displayed according to its actual width and height. offset_x and offset_y specify the offset of the image from the top-left corner of the cell where it is located. These two parameters are optional and default to 0 |
|
|
1315
|
+
| sheets.v3.spreadsheetSheetFloatImage.delete | [Delete Floating Image](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/delete) | This API is used to delete the floating image with the specified float_image_id |
|
|
1316
|
+
| sheets.v3.spreadsheetSheetFloatImage.get | [Obtain Floating Image](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/get) | ::: noteFor information about floating images, see [Floating image guide]:::This API is used to obtain floating image information based on a float_image_id |
|
|
1317
|
+
| sheets.v3.spreadsheetSheetFloatImage.patch | [Update Floating Image](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/patch) | ::: noteFor information about how to update a floating image, see [Floating image guide].:::This API is used to update the position and size parameters of an existing floating image, including range, width, height, offset_x, and offset_y. This operation cannot update float_image_id or float_image_token |
|
|
1318
|
+
| sheets.v3.spreadsheetSheetFloatImage.query | [Query Floating Image](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/query) | ::: noteFor information about floating images, see [Floating image guide]:::This API returns information on all floating images in a sheet |
|
|
1319
|
+
| sheets.v3.spreadsheetSheet.get | [Query a sheet](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/get) | This interface is used to query worksheet information by worksheet ID, including the title, index, and whether the sheet is hidden |
|
|
1320
|
+
| sheets.v3.spreadsheetSheet.moveDimension | [Move rows or columns](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/move_dimension) | 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 |
|
|
1321
|
+
| sheets.v3.spreadsheetSheet.query | [Get a sheet](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query) | This interface is used to get all worksheets and their properties under the spreadsheet, including ID, title, index, and whether the worksheet is hidden |
|
|
1322
|
+
| sheets.v3.spreadsheetSheet.replace | [Replace cells](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/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 |
|
|
1323
|
+
|
|
1324
|
+
## Business domain: speechToTextV1
|
|
1325
|
+
| MCP Tool Name | API | Description |
|
|
1326
|
+
| --- | --- | --- |
|
|
1327
|
+
| speech_to_text.v1.speech.fileRecognize | [Audio file speech recognition](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/file_recognize) | An audio speech recognition API is provided to recognize the entire audio file (less than 60s) at one time |
|
|
1328
|
+
| speech_to_text.v1.speech.streamRecognize | [Streaming speech recognition](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/speech_to_text-v1/speech/stream_recognize) | A streaming speech recognition API is provided to input an audio clip by clip and receive recognition results in real time. Each audio clip is recommended to be within 100 to 200 ms |
|
|
1329
|
+
|
|
1330
|
+
## Business domain: taskV1
|
|
1331
|
+
| MCP Tool Name | API | Description |
|
|
1332
|
+
| --- | --- | --- |
|
|
1333
|
+
| task.v1.task.batchDeleteCollaborator | [Batch delete collaborator](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_collaborator) | This API is to delete multiple collaborators from a task |
|
|
1334
|
+
| task.v1.task.batchDeleteFollower | [Batch delete followers](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_follower) | This API is to delete multiple followers from a task |
|
|
1335
|
+
| task.v1.taskCollaborator.create | [Add collaborators](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/create) | This API is used to add collaborators for a task. Multiple collaborators can be added by one request. Only the creator and collaborator of the task can add executors, and followers do not have permission to add them |
|
|
1336
|
+
| task.v1.taskCollaborator.delete | [Delete a collaborator](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/delete) | This API is used to delete a task collaborator |
|
|
1337
|
+
| task.v1.taskCollaborator.list | [Obtain a collaborator list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/list) | This API is used to obtain a task list. The result can be displayed by pages. A maximum of 50 entries are supported |
|
|
1338
|
+
| task.v1.taskComment.create | [Create a comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/create) | This API is used to create and reply to a task comment. When the value of the parent_id field is 0, this API is used to create a comment. When the value of the parent_id field is not 0, this API is used to reply to a comment |
|
|
1339
|
+
| task.v1.taskComment.delete | [Delete a comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/delete) | This API is used to delete a comment based on a comment ID |
|
|
1340
|
+
| task.v1.taskComment.get | [Obtain comment details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/get) | This API is used to obtain the details about a comment based on a comment ID |
|
|
1341
|
+
| task.v1.taskComment.list | [Get comment list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/list) | This API is used to query the task comment list, supports paging, and the maximum value is 100 |
|
|
1342
|
+
| task.v1.taskComment.update | [Update a comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/update) | This API is used to update the content of a comment |
|
|
1343
|
+
| task.v1.task.complete | [Complete a task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/complete) | This interface is used to modify the task status to "completed". Completing the task means that the entire task is completed, and the executors are not supported to complete the task separately. After the task is successfully executed, the task becomes completed for all associated users |
|
|
1344
|
+
| task.v1.task.create | [Create a task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/create) | This interface can create a task and support filling in the basic information of the task, including the title, description and collaborators of the task. On this basis, you can set deadlines and repeat rules when creating tasks, and set tasks as recurring tasks that are executed on a regular basis. By adding collaborators, other users can collaborate on the task. In addition, the interface also provides some fields that support custom content, and the caller can implement custom effects, such as jumping to the specified web page after completing the task |
|
|
1345
|
+
| task.v1.task.delete | [Delete a task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/delete) | This API is used to delete a task |
|
|
1346
|
+
| task.v1.taskFollower.create | [Add followers to a task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/create) | This API is used to add followers for a task. Multiple followers can be added in one request. The followers specified in the request must be the IDs that represent users |
|
|
1347
|
+
| task.v1.taskFollower.delete | [Delete a follower](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/delete) | This API is used to delete a follower from a task |
|
|
1348
|
+
| task.v1.taskFollower.list | [Obtain a follower list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/list) | Deprecated Version (Not Recommended)-Tasks-Follower-Obtain a follower list |
|
|
1349
|
+
| task.v1.task.get | [Obtain task details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/get) | This API is used to obtain task details, including the title, description, time, source, and other information of a task |
|
|
1350
|
+
| task.v1.task.list | [Get task list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/list) | The interface obtains all tasks related to the user by parsing the user_access_token in the header. And supports filtering tasks by task creation time and task completion status |
|
|
1351
|
+
| task.v1.task.patch | [Update a task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/patch) | This API is used to modify the title, description, time, source, and other information of a task |
|
|
1352
|
+
| task.v1.taskReminder.create | [Add reminder time](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/create) | This API is used to add reminder time for a task. The reminder time is an offset relative to the due time. The offset result cannot be earlier than the current time |
|
|
1353
|
+
| task.v1.taskReminder.delete | [Delete reminder time](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/delete) | Deletes reminder time and returns the result |
|
|
1354
|
+
| task.v1.taskReminder.list | [Query reminder time list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list) | Returns a reminder time list. The result can be displayed by pages. A maximum of 50 entries are supported |
|
|
1355
|
+
| task.v1.task.uncomplete | [Cancel completing a task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/uncomplete) | This API is used to cancel the "Completed" status of a task |
|
|
1356
|
+
|
|
1357
|
+
## Business domain: taskV2
|
|
1358
|
+
| MCP Tool Name | API | Description |
|
|
1359
|
+
| --- | --- | --- |
|
|
1360
|
+
| task.v2.attachment.delete | [Delete Attachment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/delete) | Providing an attachment GUID, delete the attachment. After deletion, the attachment cannot be recovered |
|
|
1361
|
+
| task.v2.attachment.get | [Get Attachment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/get) | Providing an attachment GUID, get the detail of the attachment, including GUID, name, size, uploaded time, temporary downloadable url, etc |
|
|
1362
|
+
| task.v2.attachment.list | [List Attachment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list) | List all attachments of a resource. The returned attachments supports paging and are sorted by upload time.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 |
|
|
1363
|
+
| task.v2.comment.create | [Create Comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/create) | Create a comment for a task, or reply to a comment for that task.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 |
|
|
1364
|
+
| task.v2.comment.delete | [Delete Comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/delete) | Delete a comment.After a comment is deleted, nothing can be done and it cannot be restored |
|
|
1365
|
+
| task.v2.comment.get | [Get Comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/get) | Given the ID of a comment, return the details of the comment, including information such as content, creator, creation time and update time |
|
|
1366
|
+
| task.v2.comment.list | [List Comments](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list) | Given a resource, returns a list of comments for that resource.Pagination is supported. Comments can return data in positive order (asc, oldest to newest) or reverse order (desc, oldest to newest) of creation time |
|
|
1367
|
+
| task.v2.comment.patch | [Patch Comment](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/patch) | Update a comment.When updating, fill in the field names of all comments to be modified in the 'update_fields 'field, and fill in the new value of the field to be modified in the'comment' field. For update api specification, please refer to the "About Resource Update" section in [Feature Overview] .Currently only the "conent" field for updating comments is supported |
|
|
1368
|
+
| task.v2.customField.add | [Add Custom Field To Resource](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/add) | 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.If the settings of the custom field are updated, all resources added by the field can receive the update and display it accordingly |
|
|
1369
|
+
| task.v2.customField.create | [Create Custom Field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create) | 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.Currently task custom fields support several types: number, member, datetime, single_select and multi_select. Use "number_setting", "member_setting", "datetime_setting", "single_select_setting", "multi_select_setting", "text_setting" to set their setting correspondingly.For example, to create a custom field of number type and add it to the tasklist with guid "ec5ed63d-a4a9-44de-a935-7ba243471c0a", you can invoke list this:```POST /task/v2/custom_fields{ "name": "price", "type": "number", "resource_type": "tasklist", "resource_id": "ec5ed63d-a4a9-44de-a935-7ba243471c0a", "number_setting": { "format": "usd", "decimal_count": 2, "separator": "thousand" }}```which means to create a custom field named as "price" with 2 decimal palces. When displayed on the app UI, it is in USD format and displays the thousand separator.Similarly, to create a single_select custom field, you may invoke api like this:```POST /task/v2/custom_fields{ "name": "priority", "type": "single_select", "resource_type": "tasklist", "resource_id": "ec5ed63d-a4a9-44de-a935-7ba243471c0a", "single_select_setting": { "options": [ { "name": "high", "color_index": 1 }, { "name": "mid", "color_index": 11 }, { "name": "low", "color_index": 16 } ] }}```which means creating a "priority" single select custom field with 3 options: high, mid, low,with color set to each of them |
|
|
1370
|
+
| task.v2.customField.get | [Get Custom Field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/get) | By specifying a custom field GUID, get its detailed information |
|
|
1371
|
+
| task.v2.customField.list | [List Custom Field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list) | 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.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.This API supports paging |
|
|
1372
|
+
| task.v2.customFieldOption.create | [Create Custom Field Option](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/create) | Add a custom option to single/multi select fields. A single/multi select field supports up to 100 options.If the newly added option is visible(is_hidden=false) , its name cannot be duplicated with the name of a visible option |
|
|
1373
|
+
| task.v2.customFieldOption.patch | [Patch Custom Field Option](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/patch) | 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.When updating, fill in the `update_fields` field, and fill in the new values of the field to be updated in the `option` field. Fields supported by update_fields include:* 'name': option name* 'color_index': Color index value of option* 'is_hidden': whether to hide from the interface* 'insert_before': Put the current option in the option_guid before an option in the same field.* 'insert_after': The option_guid that puts the current option after an option in the same field |
|
|
1374
|
+
| task.v2.customField.patch | [Patch Custom Field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/patch) | 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.`update_fields` supports:* `name`: custom field name* `number_setting`: number type setting (if and only if the custom field type to update is number)* `member_setting`: member setting (if and only if the custom field type to update is member)* `datetime_setting`: datetime type setting (if and only if the custom field type to update is datetime)* `single_select_setting`: single select setting (if and only if the custom field type to update is single select)* `multi_select_setting`: multi_select type setting (if and only if the custom field type to be updated is multi_select)* `text_setting`: text type setting (currently nothing can be set)When updating a setting, if you do not fill in a field, it means that the original setting is not changed. For example, for a number, the original settings are:```json"number_setting": { "format": "normal", "decimal_count": 2, "separator": "none", "custom_symbol": "€", "custom_symbol_position": "right"}```Invoke the API with the following parameters:```PATCH /task/v2/custom_fields/:custom_field_guid{ "custom_field": { "number_setting": { "decimal_count": 4 } }, "update_fields": ["number_setting"]}```indicates that only the number of decimal places is changed from 2 to 4, and the rest of the settings 'format', 'separator ',' custom_symbol', etc. are unchanged.For custom fields of single/multi_select type, the setting is a list of options. When updated, the usage is just like configure the options in App UI. Instead of passing in all the options for the field, the user only needs to provide the options that eventually want the UI to be visible (is_hidden = false). Options in the original field that do not appear in the input will be set to is_hidden = true and placed after all visible options.For an updated option, if `option_guid` is provided, it will be taken as option updating (in this case guid must exist in the current field, otherwise a 400 error will be returned); if GUID not provided, it will be regarded as creating a new option (the new option option_guid will be returned in reponse).For example, a single_select field originally had 3 options A, B, C, D. Where C is hidden. The user can update the options like this:```PATCH /task/v2/custom_fields/:custom_field_guid{ "custom_field": { "single_select_setting": { "options": [ { "name": "E", "color_index": 25 }, { "guid": "<option_guid of A>" "name": "A2" }, { "guid": "<option_guid of C>", }, ] } }, "update_fields": ["single_select_setting"]}```After calling, you finally get a new list of options E, A, C, B, D, where:* option E is created and its color_index is set to 25.* option A is updated and its name is changed to "A2". But its color_index remains the same because it is not set;* overall order of options follows the user's input order, that is, E, A, C, just as the direct input, and their is_hidden are set to false. Note, C was originally is_hidden = true, it will also be set to is_hidden = false.* options B and D have their is_hidden set to true because the user did not input them, and are placed after all options input in the request.If you simply want to modify the order of options visible to the user, such as changing from the original options A, B, C to C, B, A, you can invoke the API like this:```PATCH /task/v2/custom_fields/:custom_field_guid{ "custom_field": { "single_select_setting": { "options": [ { "guid": "<option_guid_of_C>" }, { "guid": "<option_guid of B>" }, { "guid": "<option_guid of A>", }, ] } }, "update_fields": ["single_select_setting"]}```If you want to directly mark all options in the field as invisible, you can invoke the API like this:```PATCH /task/v2/custom_fields/:custom_field_guid{ "custom_field": { "single_select_setting": { "options": [] } }, "update_fields": ["single_select_setting"]}```The option to update the single/multi_select field must meet the "visible option name cannot be duplicated" constraint. Otherwise, an error will be returned. Developers need to ensure that the option names entered contain on duplicated items.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 |
|
|
1375
|
+
| task.v2.customField.remove | [Remove Custom Field From Resource](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/remove) | 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.If you try to remove a custom field that does not exist in the resource, the api will return a success.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 |
|
|
1376
|
+
| task.v2.section.create | [Create Section](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/create) | 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.When creating a section in the tasklist, you need to set `resourse_type` to "tasklist" and `resource_id` to the tasklist guid.When creating section for "Owned Tasks", you need to set `resource_type` to "my_tasks", and leave `resource_id` unset. The calling identity can only create sections in "Owned Tasks" of itself |
|
|
1377
|
+
| task.v2.section.delete | [Delete Section](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/delete) | 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.Default section cannot be deleted |
|
|
1378
|
+
| task.v2.section.get | [Get Section](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/get) | 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 |
|
|
1379
|
+
| task.v2.section.list | [List Section](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list) | 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 |
|
|
1380
|
+
| task.v2.section.patch | [Patch Section](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/patch) | Update a section. you can update section's name and postion.When updating, fill in all the field names to be modified in the 'update_fields 'field, and fill in the new value of the field to be modified in the'section' field. For details of the calling convention, see the "Updates to Resources" part in [Function Overview].Section fields that currently support updates include:* 'name' - section name;* 'insert_before' - section guid before which the current section will be put.* 'insert_after' -section guid after which the current section will be put.`insert_before` and `insert_after`, if filled in, must be a valid section_guid of the same resource. Note that `insert_before` and `insert_after` cannot be set at the same time |
|
|
1381
|
+
| task.v2.section.tasks | [List Tasks of Section](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks) | List tasks of a section. Paging is supported. Tasks are returned in the order as "custom" order of UI. This API supports simple filtering |
|
|
1382
|
+
| task.v2.task.addDependencies | [Add Dependency](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_dependencies) | 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.This API can also be used to modify the type of an existing dependency (prev to next or next to prev).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 |
|
|
1383
|
+
| task.v2.task.addMembers | [Add members to task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_members) | 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.* 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 |
|
|
1384
|
+
| task.v2.task.addReminders | [Add reminders to task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_reminders) | 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.At present, a task can only set 1 reminder. But the form of the interface can be expanded to support multiple reminders for a task in the future.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 |
|
|
1385
|
+
| task.v2.task.addTasklist | [Add task to tasklist](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_tasklist) | Add a task to a tasklist. Returns the details of the task, including all tasklist information where the task belongs to.If the task is already in the manifest, the interface will return success |
|
|
1386
|
+
| task.v2.task.create | [Create Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/create) | 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.When creating a task, "assignees" and "followers" can be added by specifying `members` fields. For the format of member, please refer to the " How to represent members of tasks and tasklists?" section in [Feature Overview] .When setting task start or due time, you need to follow the specification and constraints of task time. Please refer to the "How to use start and due time?" section in [Feature Overview] .This api supports "idempotent invocation" by specifying `client_token` field. Please refer to the "Idempotent Invocation" section in [Feature Overview] .To create a subtask of a task, you need to use the [Create Subtask] API.Creating tasks allows setting custom field values at the same time. However, according to the authorization model of custom fields, only values of fields associated with tasklists can only be added to tasks. Please refer to [Custom Field Feature Overview] for details |
|
|
1387
|
+
| task.v2.task.delete | [Delete Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/delete) | Delete a task.Tasks can no longer be restored after deletion |
|
|
1388
|
+
| task.v2.task.get | [Get Task Details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/get) | This api is used to obtain task details, including task summary, description, time, members and other information |
|
|
1389
|
+
| task.v2.task.list | [List tasks](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list) | List all tasks of a specific type based on the calling identity. Paging is supported.Currently, only tasks of "my_tasks" are supported. The returned task data is in the order in which the tasks are list by "custom" order in the "Owned" in Task Center |
|
|
1390
|
+
| task.v2.task.patch | [Patch Task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/patch) | This api is used to update the summary, description, due, etc. of a task.To update a task, fill in all the field names to be updated in the `update_fields` field, and fill in the new value of the field to update in the `task` field. If the field name to be changed is included in the `update_fields`, but no new value is set in `task`, the field will be cleaned to empty. For update api specification, please refer to the "About Resource Update" section in [Feature Overview] .This api can be used to complete tasks by updating `completed_at` of task to a timestamp and restore tasks to uncompleted by setting `completed_at` to 0 . However, at present, regardless of whether the task itself is a countersign task or a or-sign task, the oapi can only support overall completion" of the task, and does not support individual completion. Besides, cannot complete a task that has bee completed. But a completed task can be restored to uncompleted by setting `completed_at` to "0".If you want to update the repeat_rule of a task, you must not also update the `completed_at` of the task or unset the due. See "How to use recuring rule of task?" section in [Tasklist Features Overview] .Task member/reminder/tasklist data cannot be updated by this api.* To add/remove task members, use [Add Task Member]And [Remove Task Member].* To modify the task reminder, use the [Add Task Reminder] and [Remove Task Reminder].* To change the tasklist where the task belongs to, use [Add Task to Tasklist] and [Remove Task from Tasklist] |
|
|
1391
|
+
| task.v2.task.removeDependencies | [Remove Dependency](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_dependencies) | Removes one or more dependencies from a task. You can remove dependencies by passing their `task_guid`.Note that if the dependency to be removed is not a dependency of the current task, it will be automatically ignored. The API will return success |
|
|
1392
|
+
| task.v2.task.removeMembers | [Remove members from task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_members) | 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 |
|
|
1393
|
+
| task.v2.task.removeReminders | [Remove task reminders](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_reminders) | Remove a reminder from the task.If the reminder to be removed does not exist in the first place, this interface will directly return success |
|
|
1394
|
+
| task.v2.task.removeTasklist | [Remove task from tasklist](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_tasklist) | Remove a task from a tasklist. Returns task details.If the task is not in the tasklist, the api will return success |
|
|
1395
|
+
| task.v2.taskSubtask.create | [Create Subtask](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/create) | Create a subtask for a task.The api function is exactly the same as the [Create Task] except that the parent task GUID needs to be provided |
|
|
1396
|
+
| task.v2.taskSubtask.list | [List Subtask](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list) | Get all subtasks of a task.Paging is supported, and data is returned in the order in which subtasks are placed on the Lark App UI |
|
|
1397
|
+
| task.v2.task.tasklists | [List tasklists of task](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/tasklists) | List the all lists where a task belongs to, including the tasklist GUID and section GUID.Only the tasklists that calling identity has read permission will be returned |
|
|
1398
|
+
| task.v2.tasklistActivitySubscription.create | [Create Activity Subscription](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/create) | Create an activity subscription for a tasklist. Each subscription can contain multiple subscribers (currently only group chats are supported). After the subscription's creation, if the corresponding event occurs in the tasklist, a notification message will be sent to the subscribers defined in the subscription. Each tasklist can create up to 50 subscriptions. Each subscription supports up to 50 subscribers.A subscription can set which kinds of events (event_key) should be notified by setting `include_keys`. If the `include_keys` are empty, no events are notified. When necessary, you can create supscription by which no notification messages will be sent by setting `disabled` to "true" |
|
|
1399
|
+
| task.v2.tasklistActivitySubscription.delete | [Delete Activity Subscription](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/delete) | Delete an activity subscription by giving a tasklist GUID and its subscription GUID. The deleted subscription is not recoverable |
|
|
1400
|
+
| task.v2.tasklistActivitySubscription.get | [Get Activity Subscription](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/get) | 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 |
|
|
1401
|
+
| task.v2.tasklistActivitySubscription.list | [List Activity Subscription](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/list) | Given the tasklist GUID, list its all activity subscriptions. Results are sorted by subscription create time |
|
|
1402
|
+
| task.v2.tasklistActivitySubscription.patch | [Patch Activity Subscription](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/patch) | 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.`update_fields` support following fields:* `name`: the name of the subscription* `subscribers`: Subscriber list. when updated, the old subscribers list will be completely replaced with the new one. Each subscription supports up to 50 subscribers. And only chat subscribers are allowed.* `include_keys`: subscribed event keys. when updated, the old list will be completely replaced with the new one. Only supported event keys are allowed (see the field description below). Duplication is not allowed.* `disabled`: whether the subscription is disabled or not |
|
|
1403
|
+
| task.v2.tasklist.addMembers | [Add Tasklist Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/add_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] .A tasklist member can be a user, app or chat. Each member can as "editor" or "viewer" role. A chat member means that all chatters in chat automatically have the tasklist role of chat memberIf the member to be added is already a member and the role is the same as set in the request, it will be automatically ignored and the api returns success.If the member to be added is already a tasklist member, and the role is not set in the request (for example, the original role is viewer, and the request is set to editor), it is equivalent to updating its role.If the member to be added is already the tasklist owner, it is automatically ignored. In this case api returns success. The role of tasklist owner does not change.This api cannot be used to update the tasklist owner. To do it, you can use the [Update Tasklist] |
|
|
1404
|
+
| task.v2.tasklist.create | [Create Tasklist](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/create) | Create a tasklist. Tasklist can be used to organize and manage multiple tasks belonging to the same project.When creating, the name of the tasklist must be filled in. At the same time, tasklist member can be set by specifying `members` field. For the format of member, please refer to the " How to represent members of tasks and tasklists?" section in [Feature Overview] .After the tasklist is created, the creator automatically becomes the tasklist owner. If sets the creator to editor/viewer, the user eventually becomes the tasklist owner and automatically disappears from the member list. This is because the same user can only have one role on the same tasklist |
|
|
1405
|
+
| task.v2.tasklist.delete | [Delete Tasklist](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/delete) | Delete a tasklist.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 |
|
|
1406
|
+
| task.v2.tasklist.get | [Get Tasklist Details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/get) | Get the details of a tasklist, including list name, owner, list members, etc |
|
|
1407
|
+
| task.v2.tasklist.list | [List Tasklists](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list) | List all the tasklists the calling identity has read permission |
|
|
1408
|
+
| task.v2.tasklist.patch | [Patch Tasklist](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/patch) | Update a tasklist. You can update the name and owner of the tasklist.When updating the tasklist, fill in all the tasklist field names to be modified in the 'update_fields 'field, and fill in the new value of the field to be modified in the'tasklist' field. For details of update api specification, please refer to the "About Resource Update" section in [Feature Overview] .Updatable fields include:* `name`: tasklist name* `owner`: tasklist ownerWhen updating tasklist owner, if the new owner is already an "editor" or "viewer", it will be directly upgraded to the owner and automatically disappear from the member list. This is because the same user can only have one role in the same tasklist. Meanwhile, you can set the new role of original owner by setting `origin_owner_to_role` field.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 |
|
|
1409
|
+
| task.v2.tasklist.removeMembers | [Remove Tasklist Members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/remove_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] .The "role" field does not need to be filled in for the member to be removed in the request, since the id and type of a member can determine the unique member in the tasklist.If the member to be removed is not in the tasklist, it is automatically ignored and the api returns success.This api cannot be used to remove the tasklist owner. If the member to be removed is the list owner, it will be automatically ignored. To update the tasklist owner, you need to call [Update Tasklist] |
|
|
1410
|
+
| task.v2.tasklist.tasks | [Get Tasks of Tasklist](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks) | Gets the summary of tasks belonging to a tasklist. This API supports pagination. Tasks in the tasklist are returned in the "custom" order.This API supports simple filtering by task completion status or task creation time range |
|
|
1411
|
+
|
|
1412
|
+
## Business domain: tenantV2
|
|
1413
|
+
| MCP Tool Name | API | Description |
|
|
1414
|
+
| --- | --- | --- |
|
|
1415
|
+
| tenant.v2.tenantProductAssignInfo.query | [Obtain company assign information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/tenant-v2/tenant-product_assign_info/query) | Obtain the seat list to be allocated under the tenant, including seat name, subscription ID, quantity and validity period |
|
|
1416
|
+
| tenant.v2.tenant.query | [Obtain company information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/tenant-v2/tenant/query) | Obtains company information such as the company name and the company ID |
|
|
1417
|
+
|
|
1418
|
+
## Business domain: translationV1
|
|
1419
|
+
| MCP Tool Name | API | Description |
|
|
1420
|
+
| --- | --- | --- |
|
|
1421
|
+
| translation.v1.text.detect | [Text language recognition](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/detect) | Machine translation (MT), supporting recognition of over 100 languages. The return value is ISO 639-1 compliant |
|
|
1422
|
+
| translation.v1.text.translate | [Translate text](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/translation-v1/text/translate) | The following languages are supported for translation: "Zh": Chinese ; "Zh-Hant": Traditional Chinese ; "En": English; " Ja ": Japanese ; " Ru ": Russian ; " de ": German ; " Fr ": French ; "It": Italian ; " pl ": Polish ; " Th ": Thai ; "Hi": Hindi ; "Id": Indonesian ; " es ": Spanish ; " Pt ": Portuguese ; " Ko ": Korean ; " vi ": Vietnamese |
|
|
1423
|
+
|
|
1424
|
+
## Business domain: trustPartyV1
|
|
1425
|
+
| MCP Tool Name | API | Description |
|
|
1426
|
+
| --- | --- | --- |
|
|
1427
|
+
| trust_party.v1.collaborationTenantCollaborationDepartment.get | [Query department details of trusted party](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/trust_party-v1/collaboration_tenant-collaboration_department/get) | Get the details of the organization's trusted party department, and you nee permission to the department to query the information. When using the user_access_token, the verification shall be aligned with the visibility rules set for the user in the trusted party list on the admin console. When using the tenant_access_token, the verification shall be aligned with the rules set for the application in the application sharing |
|
|
1428
|
+
| trust_party.v1.collaborationTenantCollaborationUser.get | [Query the details of trusted party members](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/trust_party-v1/collaboration_tenant-collaboration_user/get) | To obtain the trusted party member details, you need to have permissions on the trust party members to obtain them |
|
|
1429
|
+
| trust_party.v1.collaborationTenant.get | [Query the trusted party information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/trust_party-v1/collaboration_tenant/get) | Obtain the trusted party information based on the tenant key, and you need to have permission to the other tenant to obtain it.When using the user_access_token, the verification shall be aligned with the visibility rules set for the user in the trusted party on the admin console. When using the tenant_access_token, the verification shall be aligned with the visibility rules set for the application in the application sharing |
|
|
1430
|
+
| trust_party.v1.collaborationTenant.list | [Query visible trusted parties list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/trust_party-v1/collaboration_tenant/list) | Query a list of trusted parties visible to the user. When using the user_access_token, the permissions shall be aligned with the visibility rules set for the user in the trusted parties list on the admin console. When using the tenant_access_token, the permissions shall be aligned with the visibility rules set for the application in the application sharing |
|
|
1431
|
+
| trust_party.v1.collaborationTenant.visibleOrganization | [Query department and member information for trusted party](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/trust_party-v1/collaboration_tenant/visible_organization) | The query will return the lower-level departments, users, and user groups that are visible to the user under the collaboration department |
|
|
1432
|
+
|
|
1433
|
+
## Business domain: vcV1
|
|
1434
|
+
| MCP Tool Name | API | Description |
|
|
1435
|
+
| --- | --- | --- |
|
|
1436
|
+
| vc.v1.alert.list | [Get alert center history](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list) | Get tenant's equipment warning record under specific conditions |
|
|
1437
|
+
| vc.v1.export.get | [Query export task results](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/get) | View the progress of asynchronous export |
|
|
1438
|
+
| vc.v1.export.meetingList | [Export meeting details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/meeting_list) | Export meeting details. For specific permission requirements, please refer to "Resource introduction" |
|
|
1439
|
+
| vc.v1.export.participantList | [Export participant details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_list) | Export a list of participant details for a conference.For specific permission requirements, please refer to "Resource introduction" |
|
|
1440
|
+
| vc.v1.export.participantQualityList | [Export participant meeting quality data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_quality_list) | Export audio and video & share quality data of a participant in a conference,(Only supports ended meetings.) please refer to "Resource introduction" for specific permission requirements |
|
|
1441
|
+
| vc.v1.export.resourceReservationList | [Export meeting room reservation data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list) | Export meeting room reservation data. For specific permission requirements, please refer to "Resource introduction" |
|
|
1442
|
+
| vc.v1.meetingList.get | [Get meeting details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get) | Get meeting details.For specific permission requirements, please refer to "Resource introduction" |
|
|
1443
|
+
| vc.v1.meeting.end | [End a meeting](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/end) | Ends an ongoing meeting |
|
|
1444
|
+
| vc.v1.meeting.get | [Obtain meeting details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get) | Obtains the detailed data of a meeting |
|
|
1445
|
+
| vc.v1.meeting.invite | [Invite participants](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/invite) | Invites participants to a meeting |
|
|
1446
|
+
| vc.v1.meeting.kickout | [Remove participants](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/kickout) | Removes participants from a meeting |
|
|
1447
|
+
| vc.v1.meeting.listByNo | [List meetings of same meeting number](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no) | Obtains the meeting brief list associated with the meeting number for a specified time period (within 90 days) |
|
|
1448
|
+
| vc.v1.meetingRecording.get | [Obtain recording files](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/get) | Obtain recording files of a meeting. |
|
|
1449
|
+
| vc.v1.meetingRecording.setPermission | [Authorize recording files](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/set_permission) | Authorizes a meeting's recording files to an organization/user or makes them public to the public network |
|
|
1450
|
+
| vc.v1.meetingRecording.start | [Start recording](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start) | Start recording in a meeting. |
|
|
1451
|
+
| vc.v1.meetingRecording.stop | [Stop recording](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/stop) | Stop recording in the meeting. |
|
|
1452
|
+
| vc.v1.meeting.setHost | [Set meeting host](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/set_host) | Sets a host for a meeting |
|
|
1453
|
+
| vc.v1.participantList.get | [Get participant details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get) | Get participant details. For specific permission requirements, please refer to "Resource introduction" |
|
|
1454
|
+
| vc.v1.participantQualityList.get | [Get participant meeting quality data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get) | Get participant meeting quality data.(Only supports ended meetings) For specific permission requirements, please refer to "Resource introduction" |
|
|
1455
|
+
| vc.v1.report.getDaily | [Obtain meeting reports](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_daily) | Obtains an organizations' daily meeting usage reports for a period of time |
|
|
1456
|
+
| vc.v1.report.getTopUser | [Get top user list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_top_user) | Obtains the list of top users who use the Meetings feature most in an organization for a period of time |
|
|
1457
|
+
| vc.v1.reserveConfigAdmin.get | [Get reserve admin](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/get) | Get reserve admin |
|
|
1458
|
+
| vc.v1.reserveConfigAdmin.patch | [Update reserve admin](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/patch) | Update reserve admin |
|
|
1459
|
+
| vc.v1.reserveConfigDisableInform.get | [Get disable status change notifications](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/get) | Get disable status change notifications |
|
|
1460
|
+
| vc.v1.reserveConfigDisableInform.patch | [Update disable status change notifications](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/patch) | Update disable status change notifications |
|
|
1461
|
+
| vc.v1.reserveConfigForm.get | [Get reserve form](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/get) | Get reserve form |
|
|
1462
|
+
| vc.v1.reserveConfigForm.patch | [Update reserve form](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/patch) | Update reserve form |
|
|
1463
|
+
| vc.v1.reserveConfig.patch | [Update reserve limitation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/patch) | Update reserve limitation |
|
|
1464
|
+
| vc.v1.reserveConfig.reserveScope | [Get reserve limitation](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/reserve_scope) | Get reserve limitation |
|
|
1465
|
+
| vc.v1.reserve.apply | [Schedule a meeting](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply) | Creates a meeting scheduling |
|
|
1466
|
+
| vc.v1.reserve.delete | [Delete a schedule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete) | Deletes a schedule |
|
|
1467
|
+
| vc.v1.reserve.get | [Obtain a schedule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get) | Obtains details about a schedule |
|
|
1468
|
+
| vc.v1.reserve.getActiveMeeting | [Obtain an active meeting](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get_active_meeting) | Obtains a scheduled meeting that is currently active |
|
|
1469
|
+
| vc.v1.reserve.update | [Update a schedule](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update) | Updates a schedule |
|
|
1470
|
+
| vc.v1.resourceReservationList.get | [Get meeting room reservation data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get) | Get meeting room reservation data. For specific permission requirements, please refer to "Resource introduction" |
|
|
1471
|
+
| vc.v1.roomConfig.query | [Query meeting room configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/query) | Queries room configurations within a scope |
|
|
1472
|
+
| vc.v1.roomConfig.set | [Set up meeting room configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set) | Sets room configurations within a scope |
|
|
1473
|
+
| vc.v1.roomConfig.setCheckboardAccessCode | [set_checkboard_access_code](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_checkboard_access_code) | Create a scoped checkboard access code |
|
|
1474
|
+
| vc.v1.roomConfig.setRoomAccessCode | [set_room_access_code](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_room_access_code) | Create a range of meeting room access codes |
|
|
1475
|
+
| vc.v1.roomLevel.create | [Create room level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/create) | This API is used to create meeting room level |
|
|
1476
|
+
| vc.v1.roomLevel.del | [Delete room level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/del) | This API is used to delete a specified meeting room level |
|
|
1477
|
+
| vc.v1.roomLevel.get | [Query room level details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/get) | This API is used to query a specified meeting room level details by room level ID |
|
|
1478
|
+
| vc.v1.roomLevel.list | [Query room level list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list) | This API is used to query meeting room level list at a specified meeting room level |
|
|
1479
|
+
| vc.v1.roomLevel.mget | [Batch query room level details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/mget) | This API is used to query multi specified meeting room level details by room level IDs |
|
|
1480
|
+
| vc.v1.roomLevel.patch | [Update room level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/patch) | This API is used to update a specified meeting room level details |
|
|
1481
|
+
| vc.v1.roomLevel.search | [Search room level](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search) | This API is used to search meeting room level. Support custom room level ID to search |
|
|
1482
|
+
| vc.v1.room.create | [Create meeting room](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/create) | This API is used to create meeting room |
|
|
1483
|
+
| vc.v1.room.delete | [Delete meeting room](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/delete) | This API is used to delete a specified meeting room |
|
|
1484
|
+
| vc.v1.room.get | [Query meeting room details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/get) | This API is used to query a specified meeting room details by room ID |
|
|
1485
|
+
| vc.v1.room.list | [Query meeting room list](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list) | This API is used to query meeting room list at a specified meeting room level |
|
|
1486
|
+
| vc.v1.room.mget | [Batch query meeting room details](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/mget) | This API is used to query multi specified meeting room details by room IDs |
|
|
1487
|
+
| vc.v1.room.patch | [Update meeting room](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/patch) | This API is used to update a specified meeting room details |
|
|
1488
|
+
| vc.v1.room.search | [Search meeting room](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search) | This API is used to search meeting room. Support keyword or custom room ID to search. This API only returned meeting rooms that user has reserve permission |
|
|
1489
|
+
| vc.v1.scopeConfig.create | [Set room configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/create) | This API is used to set a scope of room level or a room configuration |
|
|
1490
|
+
| vc.v1.scopeConfig.get | [Query room configuration](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get) | This API is used to query a scope of room level or a room configuration |
|
|
1491
|
+
|
|
1492
|
+
## Business domain: verificationV1
|
|
1493
|
+
| MCP Tool Name | API | Description |
|
|
1494
|
+
| --- | --- | --- |
|
|
1495
|
+
| verification.v1.verification.get | [Obtain verification information](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/verification-v1/verification/get) | Verification Information-Obtain verification information |
|
|
1496
|
+
|
|
1497
|
+
## Business domain: wikiV1
|
|
1498
|
+
| MCP Tool Name | API | Description |
|
|
1499
|
+
| --- | --- | --- |
|
|
1500
|
+
| wiki.v1.node.search | [Search Wiki](https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki) | Docs-Wiki-Search Wiki |
|
|
1501
|
+
|
|
1502
|
+
## Business domain: wikiV2
|
|
1503
|
+
| MCP Tool Name | API | Description |
|
|
1504
|
+
| --- | --- | --- |
|
|
1505
|
+
| wiki.v2.space.create | [Create Wiki space](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/create) | This interface is used to create a Wiki space |
|
|
1506
|
+
| wiki.v2.space.get | [Access to Wiki space information](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get) | This interface is used to query the information of the Wiki space according to the Wiki space ID.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.Space sharing status:- Open: The wiki space has been published to web.- Closed: The wiki space hasn't been published to web |
|
|
1507
|
+
| wiki.v2.space.getNode | [Get Wiki node information](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node) | Get wiki node inforamtion |
|
|
1508
|
+
| wiki.v2.space.list | [Get a list of Wiki spaces](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list) | This interface is used to get a list of Wiki spaces that have permission to access.This interface is a paging interface. Due to permission filtering, the return list may be empty, but the paging flag (has_more) is true, and can continue the paging request.For the description of each attribute of the Wiki space, please refer to [Access to Wiki space information] |
|
|
1509
|
+
| wiki.v2.spaceMember.create | [Add Wiki space members](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create) | Add Wiki space members |
|
|
1510
|
+
| wiki.v2.spaceMember.delete | [Delete Wiki space members](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/delete) | This method is used to delete Wiki space members |
|
|
1511
|
+
| wiki.v2.spaceMember.list | [Obtain Wiki space members](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list) | Obtain Wiki space members |
|
|
1512
|
+
| wiki.v2.spaceNode.copy | [Create a node copy](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/copy) | This interface is used for creating a copy of a node to a specified location |
|
|
1513
|
+
| wiki.v2.spaceNode.create | [Create node](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/create) | This interface is used to create [node] in the wiki space at given location |
|
|
1514
|
+
| wiki.v2.spaceNode.list | [Get the list of child nodes in Wiki](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list) | This interface is used for pagination to get the list of child nodes of Wiki nodes.This interface is a paging interface. Due to permission filtering, the return list may be empty, but the paging flag (has_more) is true and can continue the paging request |
|
|
1515
|
+
| wiki.v2.spaceNode.move | [Move node in Wiki](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move) | This method is used to move nodes within the Wiki and supports movement across the Wiki space |
|
|
1516
|
+
| wiki.v2.spaceNode.moveDocsToWiki | [Move cloud document to Wiki](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move_docs_to_wiki) | This interface allows to move existing cloud documents to the Wiki at given location |
|
|
1517
|
+
| wiki.v2.spaceNode.updateTitle | [Update title](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/update_title) | This interface is used for updating node title |
|
|
1518
|
+
| wiki.v2.spaceSetting.update | [Update Wiki space settings](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-setting/update) | Update the public settings of the Wiki space according to space_id |
|
|
1519
|
+
| wiki.v2.task.get | [Retrieve the result of Wiki task](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/task/get) | This method is used to retrieve the result of a wiki task |
|
|
1520
|
+
|
|
1521
|
+
## Business domain: workplaceV1
|
|
1522
|
+
| MCP Tool Name | API | Description |
|
|
1523
|
+
| --- | --- | --- |
|
|
1524
|
+
| workplace.v1.customWorkplaceAccessData.search | [Get Custom Workplace Access Data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search) | Get Custom Workplace Access Data |
|
|
1525
|
+
| workplace.v1.workplaceAccessData.search | [search workplace access data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search) | Get Workplace Access Data, including default workplace and custom workplace |
|
|
1526
|
+
| workplace.v1.workplaceBlockAccessData.search | [Get Block Access Data](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search) | Workplace-workplace access data-Get Block Access Data-Get Custom Workplace Block Access Data |
|
|
1527
|
+
|