PicoBot/.qoder/skills/lark-im/references/lark-im-flag-list.md

im +flag-list

Prerequisite: Read ../lark-shared/SKILL.md for authentication, global parameters, and security rules.

This skill maps to shortcut: lark-cli im +flag-list. Underlying API: GET /open-apis/im/v1/flags.

Sorting Rules (Important)

The API returns data sorted by update_time in ascending order, meaning oldest first, newest last. When has_more=true, you cannot simply take the first page's items as the latest flags — you must paginate through all pages and take the last item on the last page as the newest.

Recommended: use --page-all for auto-pagination to get the complete list, then use -q '.data.flag_items[-1]' to get the latest item.

Commands

# Fetch first page (default page-size=50)
lark-cli im +flag-list --as user

# Manual pagination with custom page size
lark-cli im +flag-list --as user --page-size 30 --page-token <page_token>

# Auto-paginate to get all flags (recommended)
lark-cli im +flag-list --as user --page-all

# Auto-paginate + get the latest flag
lark-cli im +flag-list --as user --page-all -q '.data.flag_items[-1]'

# Auto-paginate + get only item_id list
lark-cli im +flag-list --as user --page-all -q '.data.flag_items[].item_id'

# Disable auto-enrichment of message content (enabled by default)
lark-cli im +flag-list --as user --page-all --enrich-feed-thread=false

# Limit max pages (default 20, max 1000)
lark-cli im +flag-list --as user --page-all --page-limit 10

Parameters

Parameter	Default	Description
--page-size <n>	50	Range 1-50 (server max is 50)
--page-token <token>	empty	Pagination token from previous page; empty string must still be provided
--page-all	false	Auto-paginate to fetch all pages and merge results
--page-limit <n>	20	Max pages in --page-all mode (max 1000)
--enrich-feed-thread	true	Auto-enrich feed-layer thread entries with message content (calls im.messages.mget)
--as user	Required	Currently only supports user identity

Response Structure

The response has data as the main body, with fields described below:

Field	Type	Description
flag_items	array	List of currently existing (not canceled) flags, sorted by update_time ascending
delete_flag_items	array	List of previously canceled flags, sorted by update_time ascending
messages	array	Message content inlined by the server for (default, message) type flags
has_more	boolean	Whether there's a next page
page_token	string	Pagination token for the next page

Note: (thread, feed) / (msg_thread, feed) entries are automatically enriched via mget by the shortcut, and written to the corresponding entry's message field.

Limitations

• delete_flag_items are not enriched: Message content is only fetched for active flags (flag_items), not canceled flags (delete_flag_items). If you need message content for a canceled flag, query the message separately using +messages-mget --message-ids <item_id>.

Response Example (Sanitized)

{
  "data": {
    "delete_flag_items": [
      {
        "create_time": "xxx",
        "flag_type": "xxx",
        "item_id": "xxx",
        "item_type": "xxx",
        "update_time": "xxx"
      }
    ],
    "flag_items": [
      {
        "create_time": "xxx",
        "flag_type": "xxx",
        "item_id": "xxx",
        "item_type": "xxx",
        "update_time": "xxx"
      }
    ],
    "has_more": false,
    "messages": [],
    "page_token": "xxx"
  }
}

Permissions

• Base scope: im:feed.flag:read
• Additional scopes only when --enrich-feed-thread=true needs to fetch missing message content: im:message.group_msg:get_as_user, im:message.p2p_msg:get_as_user