Local API V2 – Extension and Bookmark Interface

Get Profile Bookmarks

Endpoint

GET /openapi/v2/profiles/{profileId}/bookmarks

Returns the Bookmark content and Bookmark settings for the specified Profile.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Profile ID.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "profile_id": "1876881021063852034",
    "content": {},
    "settings": {}
  },
  "next": null
}

Replace Profile Bookmarks

Endpoint

PUT /openapi/v2/profiles/{profileId}/bookmarks

Replaces the Bookmark content and Bookmark settings for the specified Profile. This operation uses the request body as the source of truth. Use it with caution.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Profile ID.

Request Parameters

Name	Type	Required	Description
content	object	No	Bookmark content.
settings	object	No	Bookmark settings.

Request Example

{
  "content": {},
  "settings": {}
}

Copy Bookmarks to a Profile

Endpoint

POST /openapi/v2/profiles/{profileId}/bookmarks/copy

Copies Bookmarks from a source Profile to a target Profile. The profileId in the path is the target Profile ID.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Target Profile ID.

Request Parameters

Name	Type	Required	Description
source_profile_id	string	No	Source Profile ID.
include_settings	boolean	No	Whether to copy Bookmark settings as well. The default is true.

Request Example

{
  "source_profile_id": "1876881021063852999",
  "include_settings": true
}

Update Profile Extension Settings

Endpoint

PATCH /openapi/v2/profiles/{profileId}/extensions

Updates the Extension management mode and Extension group for the specified Profile.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Profile ID.

Request Parameters

Name	Type	Required	Description
mode	string	No	Extension mode. Allowed values: allow, ban.
group_id	string	No	Extension group ID. Pass an empty value to leave the Profile unassigned to an Extension group.

Request Example

{
  "mode": "allow",
  "group_id": "1876881021063852888"
}

List Extensions

Endpoint

GET /openapi/v2/extensions

Returns the team’s Extensions.

Query Parameters

Name	Type	Required	Description
request	string	Yes	Extension list query parameters.

Response Parameters

data.list contains the Extensions:

Name	Type	Description
id	string	Extension ID.
name	string	Extension name.
version	string	Extension version.
source	string	Extension source: local, google, or dicloak.
groups	object[]	Groups that contain the Extension.

Add an Extension from a Chrome Web Store Link

Endpoint

POST /openapi/v2/extensions

Adds an Extension to the current team from its Chrome Web Store detail page URL. Once added, the Extension appears in the Extension list and can be assigned to Profiles through Extension groups.

Only Chrome Web Store detail page URLs are currently supported. Uploading local Extension packages is not supported.

Request Parameters

Name	Type	Required	Description
url	string	Yes	Chrome Web Store Extension detail page URL.
extension_group_ids	string[]	No	Extension group IDs. If omitted, the default Extension group is used automatically.
status	string	No	Extension status after it is added. Allowed values: ENABLED, DISABLED. The default is DISABLED.
pin_type	string	No	How the Extension icon is pinned. Allowed values: CUSTOMIZE_PIN, PIN, UN_PIN. The default is CUSTOMIZE_PIN.
browser_hide	boolean	No	Whether to hide the Extension icon in the browser. The default is false.
hide_role_id	string[]	No	IDs of the roles for which the Extension icon is hidden. The default is ["all"] when omitted.

Request Example

{
  "url": "https://chromewebstore.google.com/detail/simpleundoclose/plmkckmepaemlbdcihcfiffecmmnofil",
  "status": "DISABLED"
}

Response Parameters

data contains information about the added Extension:

Name	Type	Description
id	string	Extension record ID.
browser_extensions_id	string	Base Extension record ID or Extension identifier.
unique_id	string	Chrome Web Store Extension ID.
extensions_name	string	Extension name.
extensions_introduce	string	Extension description.
download_url	string	Extension package URL.
icon_url	string	Extension icon URL.
md5_hash	string	Extension package MD5 hash.
sha256_hash	string	Extension package SHA256 hash. An empty string if not returned.
source	string	Extension source. Always GOOGLE.
status	string	Extension status: ENABLED or DISABLED.
version	string	Extension version.
original_url	string	Original Chrome Web Store URL.
pin_type	string	How the Extension icon is pinned.
browser_hide	boolean	Whether the Extension icon is hidden.
hide_role_id	string[]	IDs of the roles for which the Extension icon is hidden.
extension_group_ids	string[]	IDs of the groups that contain the Extension.
already_exists	boolean	Whether the Extension already exists in the team.
downloaded	boolean	Whether this request downloaded the Extension package.

If the Extension already exists in the team, the endpoint returns the existing Extension information and sets already_exists to true.

List Extension Groups

Endpoint

GET /openapi/v2/extension-groups

Returns the list of Extension groups.

Query Parameters

Name	Type	Required	Description
request	string	Yes	Extension group list query parameters.

Response Parameters

data.list contains the Extension groups:

Name	Type	Description
id	string	Extension group ID.
name	string	Extension group name.
remark	string	Remarks.
created_at	string	Creation time.
updated_at	string	Last update time.

Delete an Extension

Endpoint

DELETE /openapi/v2/extensions/{extensionId}

Deletes the specified Extension. Profiles that use the Extension may be affected after it is deleted. Use this operation with caution.

Path Parameters

Name	Type	Required	Description
extensionId	string	Yes	Extension ID.