Accounts Status API

This page documents the API endpoint for querying the status of all accounts managed in TikMatrix, including device online/offline status, login state, and tags.

List Accounts

Retrieve all accounts with enriched status information.

• Endpoint: GET /api/v1/accounts

Query Parameters

Parameter	Type	Default	Description
platform	string	—	Filter by platform: tiktok or instagram
device	string	—	Filter by device serial number
logined	integer	—	Filter by login status: 0 = not logged in, 1 = logged in
status	integer	—	Filter by account status: 0 = enabled, 1 = disabled
tag	string	—	Filter by tag (exact match)
page	integer	1	Page number (1-based)
page_size	integer	20	Items per page (max 100)

Response Fields

Field	Type	Description
accounts	array	List of account objects (see below)
total	integer	Total number of accounts matching filters
page	integer	Current page number
page_size	integer	Items per page

Account Object

Field	Type	Description
id	integer	Account database ID
username	string | null	Social media username
email	string | null	Account email address
platform	string	Platform: tiktok or instagram
packagename	string | null	Clone app package name (null = default app)
device	string | null	ADB device serial number
device_online	boolean	Whether the device is currently connected
device_name	string	Device model name (empty string when offline)
logined	integer	0 = not logged in, 1 = logged in
logined_text	string	"logged_in" or "not_logged_in"
status	integer	0 = enabled, 1 = disabled
status_text	string	"enabled" or "disabled"
tags	string[]	Tags assigned to this account

Security

The account password is never included in API responses.

Example

curl "http://localhost:50809/api/v1/accounts?page=1&page_size=20"

Filter by platform and login status:

curl "http://localhost:50809/api/v1/accounts?platform=tiktok&logined=1&page=1&page_size=50"

Filter by device serial:

curl "http://localhost:50809/api/v1/accounts?device=emulator-5554"

Sample Response

{
  "code": 0,
  "message": "success",
  "data": {
    "accounts": [
      {
        "id": 1,
        "username": "my_tiktok_user",
        "email": "user@example.com",
        "platform": "tiktok",
        "packagename": null,
        "device": "emulator-5554",
        "device_online": true,
        "device_name": "sdk_gphone64_x86_64",
        "logined": 1,
        "logined_text": "logged_in",
        "status": 0,
        "status_text": "enabled",
        "tags": ["batch-a", "vip"]
      },
      {
        "id": 2,
        "username": "another_user",
        "email": null,
        "platform": "tiktok",
        "packagename": "com.zhiliaoapp.musically.clone1",
        "device": "192.168.1.101:5555",
        "device_online": false,
        "device_name": "",
        "logined": 0,
        "logined_text": "not_logged_in",
        "status": 1,
        "status_text": "disabled",
        "tags": []
      }
    ],
    "total": 2,
    "page": 1,
    "page_size": 20
  }
}

Error Responses

HTTP Status	Code	Description
403	40301	Forbidden — API access requires Pro+ plan
500	50001	Internal server error