Feishu Open Platform API

https://open.feishu.cn/document/server-docs
Admin
Feishu Open Platform API documentation provides comprehensive endpoints and integration guides for...
Tokens:2,184,945
Snippets:10,051
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Feishu SDK for Golang

Source: https://open.feishu.cn/document/server-docs/event-subscription-guide/event-subscription-configure-/request-url-configuration-case

Install the Feishu SDK for Golang using the go get command.

```bash
go get -u github.com/larksuite/oapi-sdk-go/v3
```

--------------------------------

### Go SDK request example

Source: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge/get

Go SDK example for the Get badge detail API. It imports the required oapi-sdk-go packages and demonstrates how to call the API with the tenant_access_token.

```go
package main

import (
  "context"
  "fmt"
  "github.com/larksuite/oapi-sdk-go/v3"
  "github.com/larksuite/oapi-sdk-go/v3/core"
  "github.com/larksuite/oapi-sdk-go/v3/service/admin/v1"
)

// SDK 使用文档：https://open.feishu.cn/document/uAjLw4CM/
```

--------------------------------

### Get data item - Go SDK request example

Source: https://open.feishu.cn/document/server-docs/search-v2/open-search/data_source-item/get

Go SDK example for getting a data item. The code is incomplete in the source, showing only the import statements and a comment. It is part of the request example for the Get data item API.

```go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/search/
v2"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
```

--------------------------------

### Response body example for Get location list

Source: https://open.feishu.cn/document/server-docs/corehr-v1/organization-management/location/list

Response body example for the Get location list API. Shows a successful response with code 0 and msg 'success', including an item with id and hiberarchy_common details. The example is truncated in the source.

```json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "4718803945687580505",
"hiberarchy_common": {
"parent_id": "4719168654814483759",
"name": [
{
"lang": "zh-CN",
"value": "刘梓新"
}
],
"type": {
"enum_name": "Location",
"display": [
{
"lang": "zh-CN",
```

--------------------------------

### Go SDK event subscription setup

Source: https://open.feishu.cn/document/server-docs/application-v6/event/app_ticket-events

Go SDK sample for subscribing to events via persistent connection. Imports required packages and starts the main function. The code is incomplete and truncated in the source.

```go
package main
import (
"context"
"fmt"
larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
"github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
"github.com/larksuite/oapi-sdk-go/v3/service/application/old"
larkws "github.com/larksuite/oapi-sdk-go/v3/ws"
)
// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/
uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/
preparations
func main() {
```

--------------------------------

### Response body example for get conditional formatting

Source: https://open.feishu.cn/document/server-docs/docs/sheets-v3/conditionformat/condition-format-get

Example response body for a successful get conditional formatting request. Shows the structure with sheet_condition_formats, condition_format details, and style properties.

```json
{
    "code": 0,
    "msg": "Success"，
    "data": {
        "sheet_condition_formats": [
            {
                "condition_format": {
                    "cf_id": "r9sYuhgAl6",
                    "ranges": [
                        "uEnW3A!C4:C4"
                    ],
                    "rule_type": "timePeriod",
                    "attrs": [
                        {
                            "operator": "is",
                            "time_period": "today"
                        }
                    ],
                    "style": {
                        "back_color": "#d9f5d6",
                        "font": {
                            "bold": true,
                            "italic": false
                        },
                        "fore_color": "#faf1d1",
                        "text_decoration": 3
                    }
                },
                "sheet_id": "uEnW3A"
            }
        ]
    }
}
```

--------------------------------

### Go SDK Example for Batch Query Comments

Source: https://open.feishu.cn/document/server-docs/docs/CommentAPI/batch_query

This Go SDK example demonstrates how to call the batch_query API. It imports the necessary SDK packages and sets up the client. The example is part of the standard request examples provided for multiple languages.

```go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/drive/
v1"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
```

--------------------------------

### Get User Information with Go SDK

Source: https://open.feishu.cn/document/server-docs/authentication-management/login-state-management/get

Go SDK example for getting user information via user_access_token. The code is truncated in the source; the full example is available in the API Explorer.

```go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
ukTMukTMukTM/server-side-sdk/
golang-sdk-guide/preparations
// 复制该 Demo 后, 需要将 
```

--------------------------------

### Response body example for Get talent field

Source: https://open.feishu.cn/document/server-docs/hire-v1/candidate-management/talent/query

Example response body for the Get talent field API. Shows a successful response with code 0 and a data object containing an items array with talent field details. The example is truncated in the source.

```json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "6949805467799537964",
"name": {
"zh_cn": "测试",
"en_us": "test"
},
"description": {
"zh_cn": "测试",
"en_us": "test"
},
"setting": {
"object_type": 1,
"config": {
"options": [
{
```

--------------------------------

### Go SDK example for creating a task

Source: https://open.feishu.cn/document/server-docs/task-v1/task/create

Example code for creating a task using the Feishu Go SDK. It imports the necessary packages and sets up the client. The code is incomplete as shown in the source.

```go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/task/v1"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
ukTMukTMukTM/server-side-sdk/
```

--------------------------------

### Go SDK request example

Source: https://open.feishu.cn/document/server-docs/corehr-v1/pre_hire/list

Example Go SDK code for listing pre-hire records. The snippet is incomplete in the source, showing only the package imports.

```Go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/corehr/
v1"
)
```

--------------------------------

### Response body example for Get personal information

Source: https://open.feishu.cn/document/server-docs/corehr-v1/employee/person/get

Response body example for the 'Get personal information' API. Shows a successful response with code 0 and msg 'success', including the person object with fields such as phone_number, legal_name, preferred_name, id, and name_list. The example is truncated in the source.

```json
{
"code": 0,
"msg": "success",
"data": {
"person": {
"phone_number": "11111111111",
"legal_name": "张三",
"preferred_name": "张四",
"id": "646465654545",
"name_list": [
{
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "刘梓新"
}
]
}
}
]
}
}
}
```

--------------------------------

### Go SDK example for creating a badge

Source: https://open.feishu.cn/document/server-docs/admin-v1/badge/badge/create-2

Go SDK example for creating a badge. The code is incomplete in the source; only the package declaration, imports, and a comment are shown. The comment references the SDK documentation URL.

```go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/admin/
v1"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
```

--------------------------------

### GET /open-apis/vc/v1/participant_list

Source: https://open.feishu.cn/document/server-docs/vc-v1/meeting-room-data/get-2

Documentation for the GET participant_list endpoint, including query parameters, headers, and request example.

```APIDOC
## [GET] https://open.feishu.cn/open-apis/vc/v1/participant_list

### Description
Retrieves the list of participants for a meeting based on the provided meeting details. This endpoint requires authentication via an access token and supports both tenant and user access tokens.

### Method
GET

### Endpoint
https://open.feishu.cn/open-apis/vc/v1/participant_list

### Parameters
#### Query Parameters
- **meeting_start_time** (string) - Required - Meeting start time (Unix time, unit second). Example: "1655276858"
- **meeting_end_time** (string) - Required - Meeting end time (Unix time, unit second). If the meeting is in progress, fill in the current time; otherwise, fill in the accurate meeting end time. Example: "1655276858"
- **meeting_status** (int) - Optional - Meeting status (defaults to ended meeting if not passed). Optional values: 1 (in progress), 2 (ended), 3 (to be held). Example: 2
- **meeting_no** (string) - Required - Meeting number. Example: "123456789"
- **user_id** (string) - Optional - User ID. Example: "ou_3ec3f6a28a0d08c45d895276e8e5e19b"
- **room_id** (string) - Optional - Room ID. Example: "omm_eada1d61a550955240c28757e7dec3af"
- **page_size** (int) - Optional - Paging size. Default: 20. Value range: 20-100. Example: 20
- **page_token** (string) - Optional - Page identifier. Not filled in the first request, indicating traversal from the beginning; when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups. Example: "20"
- **webinar_user_role** (string) - Optional - Webinar user role. Example: "0"
- **user_id_type** (string) - Optional - User ID categories. Optional values: open_id, union_id, user_id. Default: open_id. When the value is user_id, the following field scopes are required: Obtain user ID (only custom apps). Example: "open_id"

#### Request Headers
- **Authorization** (string) - Required - Access token for authentication. Value format: "Bearer `access_token`". Supported options: tenant_access_token, user_access_token. Example: "Bearer t-g1044qeGEDXTB6NDJOGV4JQCYDGHRBARFTGT1234"
- **Content-Type** (string) - Required - Fixed value: "application/json; charset=utf-8"

### Request Example
```
GET https://open.feishu.cn/open-apis/vc/v1/participant_list?meeting_start_time=1655276858&meeting_end_time=1655276858&meeting_status=2&meeting_no=123456789&user_id=ou_3ec3f6a28a0d08c45d895276e8e5e19b&room_id=omm_eada1d61a550955240c28757e7dec3af&page_size=20&page_token=20&webinar_user_role=0&user_id_type=open_id
```

### Response
#### Success Response (200)
The response body contains sensitive fields that are returned only after corresponding scopes are added. The response includes participant list data, but the exact response schema is not provided in the source.

#### Response Example
Not provided in the source.

### Error Handling
Not provided in the source.
```

--------------------------------

### Go SDK request example (partial)

Source: https://open.feishu.cn/document/server-docs/docs/permission/permission-public/permission-public-password/update

Go SDK imports and main function start for updating the public password of a file permission. The code is incomplete in the source, showing only the beginning of the example.

```go
package main
import (
	"context"
	"fmt"
	"github.com/larksuite/
oapi-sdk-go/v3"
	"github.com/larksuite/
oapi-sdk-go/v3/core"
	"github.com/larksuite/
oapi-sdk-go/v3/service/drive/
v1"
)
```

--------------------------------

### Response body example for get document content

Source: https://open.feishu.cn/document/server-docs/docs/docs/docs/content/get-document

Example response body for the get document content API. Shows a successful response with code 0, message 'Success', and data containing the document content and revision number.

```json
{
    "code": 0,
    "msg": "Success",
    "data": {
        "content": "{}",
        "revision": 1000  
    }
}

```

--------------------------------

### Go SDK event subscription setup for App Created

Source: https://open.feishu.cn/document/server-docs/application-v6/event/created

Go SDK imports and main function for setting up a persistent connection to receive events. Includes SDK user guide link and imports for larkcore, larkevent, dispatcher, application/v6, and larkws.

```go
package main

import (
	"context"
	"fmt"
	larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
	larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
	"github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
	"github.com/larksuite/oapi-sdk-go/v3/service/application/v6"
	larkws "github.com/larksuite/oapi-sdk-go/v3/ws"
)

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/
uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/
preparations
func main() {

```

--------------------------------

### Go SDK request example for termination reasons

Source: https://open.feishu.cn/document/server-docs/hire-v1/candidate-management/delivery-process-management/application/list-2

Shows a Go SDK code snippet for calling the termination reasons API. It imports the necessary packages and sets up the client. The code is incomplete as it only shows the package main and imports.

```Go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/hire/v1"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
ukTMukTMukTM/server-side-sdk/
```

--------------------------------

### GET /open-apis/contact/v3/scopes

Source: https://open.feishu.cn/document/server-docs/contact-v3/scope/list

This code snippet documents the GET /open-apis/contact/v3/scopes endpoint, including its parameters, request example, and response structure.

```APIDOC
## [GET] /open-apis/contact/v3/scopes

### Description
This endpoint retrieves the scope of the application's address book permission, returning the list of departments, users, and user groups within the authorized scope.

### Method
GET

### Endpoint
https://open.feishu.cn/open-apis/contact/v3/scopes

### Parameters
#### Path Parameters
None

#### Query Parameters
- **user_id_type** (string) - Optional - User ID type. Optional values: `open_id`, `union_id`, `user_id`. Default: `open_id`.
- **department_id_type** (string) - Optional - Department ID type. Optional values: `department_id`, `open_department_id`. Default: `open_department_id`.
- **page_token** (string) - Optional - Page identifier for pagination. Not filled in the first request.
- **page_size** (int) - Optional - Page size, value range 1-100. Default: 50.

#### Request Body
None

### Request Example
```
GET /open-apis/contact/v3/scopes?user_id_type=user_id&department_id_type=department_id&page_size=50
Authorization: Bearer t-g1044qeGEDXTB6NDJOGV4JQCYDGHRBARFTGT1234
Content-Type: application/json; charset=utf-8
```

### Response
#### Success Response (200)
- **department_ids** (array) - List of department IDs within the scope.
- **user_ids** (array) - List of user IDs within the scope.
- **group_ids** (array) - List of user group IDs within the scope.
- **has_more** (boolean) - Whether there are more items.
- **page_token** (string) - Next page token.

#### Response Example
```json
{
  "department_ids": ["od-123"],
  "user_ids": ["ou_123"],
  "group_ids": ["og_123"],
  "has_more": false,
  "page_token": ""
}
```

### Error Handling
- **400** - Invalid request parameters.
- **401** - Unauthorized, invalid or missing access token.
- **403** - Forbidden, insufficient permissions.
- **429** - Rate limit exceeded.
- **500** - Internal server error.
```

--------------------------------

### Response body example for Get resume source list

Source: https://open.feishu.cn/document/server-docs/hire-v1/candidate-management/resume_source/list

Example JSON response body for the Get resume source list API. Shows a successful response with code 0, a list of resume source items, and pagination fields.

```JSON
{"code":0,
"msg":"success",
"data":{"items":[{
"id": "1111",
"zh_name": "内推",
"en_name": "referral",
"active_status": 1,
"resume_source_type": "10001"
}],
"page_token":"1",
"has_more":True}}
```
Tokens:
Raw