- API
- Automation
- Docker
- Browserless(Beta)
GetProfiles
GET
/profiles
v2/Profiles
Request
Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************Query Params
page
stringÂ
optional
pageSize
stringÂ
optional
s
stringÂ
optional
tags
stringÂ
optional
groupId
stringÂ
optional
Body Params multipart/form-data
object {0}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:8848/api/v2/profiles' \
--header 'x-api-key;'Responses
🟢200OK
application/json
Body
code
integerÂ
required
data
objectÂ
required
docs
array [object {23}]Â
required
totalDocs
integerÂ
required
offset
integerÂ
required
limit
integerÂ
required
totalPages
integerÂ
required
page
integerÂ
required
pagingCounter
integerÂ
required
hasPrevPage
booleanÂ
required
hasNextPage
booleanÂ
required
prevPage
integerÂ
required
nextPage
integerÂ
required
err
booleanÂ
required
msg
stringÂ
required
Example
{
"code": 0,
"data": {
"docs": [
{
"args": {
"--restore-last-session": "string",
"https://google.com/": "string"
},
"createdAt": "string",
"fingerprintId": "string",
"group": {
"__v": 0,
"_id": "string",
"createdAt": "string",
"extensionIds": [
"string"
],
"groupId": "string",
"isDefault": true,
"name": "string",
"note": "string",
"settings": {
"args": {
"--disable-backgrounding-occluded-windows": "string",
"--restore-last-session": "string",
"--start-maximized": "string",
"https://google.com/": "string"
},
"bookmarks": [
"string"
],
"browserLanguage": "string",
"dnsServer": "string",
"startupUrls": [
"string"
],
"syncCookies": true,
"vault": true,
"syncProfileHistoryData": true
},
"status": 0,
"teamId": "string",
"updatedAt": "string",
"userId": "string"
},
"groupId": "string",
"kernel": 0,
"kernelMilestone": "string",
"kernelVersion": "string",
"lastLaunchRecord": {
"createdAt": "string",
"kernel": 0,
"kernelCustomVersion": "string",
"kernelMilestone": "string",
"platform": 0,
"profileId": "string",
"teamId": "string",
"updatedAt": "string",
"userId": "string"
},
"name": "string",
"note": "string",
"platform": 0,
"platformVersion": "string",
"profileId": "string",
"proxyConfig": {
"alias": "string",
"checker": "string",
"host": "string",
"password": "string",
"port": "string",
"protocol": "string",
"proxyGroupId": null,
"proxyGroupName": null,
"proxyId": null,
"proxySetting": "string",
"proxyType": "string",
"regionInfo": null,
"url": "string",
"useTeamConfig": true,
"username": "string"
},
"proxyResult": {
"checker": null,
"city": "string",
"country": "string",
"ip": "string",
"metadata": {
"city": "string",
"countryLong": "string",
"countryShort": "string",
"ip": "string",
"latitude": "string",
"localTime": "string",
"longitude": "string",
"money": "string",
"region": "string",
"timezone": "string",
"zipcode": "string"
},
"state": "string",
"timezone": "string",
"checkedAt": "string",
"protocol": "string"
},
"status": 0,
"tags": [
{
"color": "string",
"name": "string"
}
],
"teamId": "string",
"uaFullVersion": "string",
"updatedAt": "string",
"userId": "string",
"platformMilestone": "string"
}
],
"totalDocs": 0,
"offset": 0,
"limit": 0,
"totalPages": 0,
"page": 0,
"pagingCounter": 0,
"hasPrevPage": true,
"hasNextPage": true,
"prevPage": 0,
"nextPage": 0
},
"err": true,
"msg": "string"
}