List profiles

GET

http://127.0.0.1:58931/api/profiles

GET

/api/profiles

$ curl http://127.0.0.1:58931/api/profiles \
>      -H "X-API-Key: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "success": true,
3   "code": 0,
4   "data": {
5     "total": 1,
6     "page": 1,
7     "page_size": 1,
8     "configs": [
9       {
10         "profile_uuid": "a3f1c9d2-4b7e-4f8a-9d3e-2b5f6c7d8e9f",
11         "profile_name": "Work Browser Profile",
12         "note": "Profile used for work-related browsing",
13         "stars_status": 1,
14         "folder_config": {
15           "folder_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
16           "folder_name": "Work Profiles"
17         },
18         "browser_config": {
19           "system_os": "Windows",
20           "system_version": "10.0.19044",
21           "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36"
22         },
23         "proxy_mode": "no_proxy",
24         "proxy_config": {
25           "proxy_uuid": "",
26           "proxy_type": "no_proxy",
27           "host": "",
28           "port": "",
29           "username": "",
30           "password": "",
31           "ipchecker": "",
32           "ip": "",
33           "ip_country": "",
34           "ip_region": "",
35           "ip_city": "",
36           "refresh_url": "",
37           "proxy_ip_updated_time": ""
38         },
39         "rotating_proxy": {
40           "traffic_type": "res",
41           "selected_level": "global",
42           "region_path_key": "",
43           "country_code": "",
44           "country_name": "",
45           "state_name": "",
46           "state_proxy_val": "",
47           "city_name": "",
48           "city_proxy_val": ""
49         },
50         "browser_lock": {
51           "user_name": "jdoe",
52           "user_uuid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
53         },
54         "created_at": "1686787200"
55       }
56     ]
57   }
58 }

List browser profiles with pagination and search.

Authentication

X-API-Keystring

API Key generated in the FlashID app.

Query parameters

pageintegerOptionalDefaults to 1

page_sizeintegerOptionalDefaults to 50

keywordstringOptional

Search keyword

folder_uuidstringOptional

A custom folder UUID, or a built-in id: all | starred

sort_byenumOptional

Allowed values:

sort_orderenumOptional

Allowed values:

Response

Success

successboolean

codeinteger

dataobjectOptional