Skip to content
Local APIPlatform accounts

List account platforms ​

Version overview
GET
/api/v1/account-platforms

Return all system preset and custom platforms available to the current user without pagination. Supports filtering by type or keyword. The response excludes internal fields such as page element locators.

Request parameters

Authorization Bearer Token

Include your API Key as a Bearer token in the Authorization request header.

Authorization: Bearer <api-key>

Query parameters

2
Fields
string
Filter by system preset or user-defined platform
Enum
string
Case-insensitive filter by platform name, website, category, or region
minLength: 1maxLength: 100

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

curl -H 'Authorization: Bearer <TOKEN>' 'http://local.zhongyibrowser.com:39025/api/v1/account-platforms'

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

Account platform list

Body

application/jsonAccountPlatformListSuccessResponse
Fields
numberrequired
Business status code; always 0 on success
Enum
stringrequired
Business status message; always success on success
Enum
objectrequired
Endpoint business data

Additional fields are not allowed.

Example

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "string",
        "type": "preset",
        "website": "string",
        "icon_url": "string",
        "platform_code": "string",
        "platform_name": "string",
        "category": {
          "code": "string",
          "name": "string"
        },
        "region": {
          "code": "string",
          "name": "string"
        }
      }
    ]
  }
}

View all business error codes and HTTP statuses

ZYBrowser Local API documentation