Skip to main content
GET/api/public/v1/profiles

profiles.list

Profiles visible to the key's owner; filter by state, q, group, tag, os, network; keyset paginated.

Capability: profile.readPaginatedMCP tool: profiles_list
View as Markdown

Parameters

NameTypeRequiredDescription
limitqueryintegerNoPage size (max 100) (min 1, max 100) Default: `50`.
cursorquerystringNopage.next_cursor from the previous page (max length 400)
statequery"active" | "trashed"NoDefault: `"active"`.
qquerystringNoSearch name, number, notes (max length 120)
groupquery"none" | string (uuid)NoGroup id, or none for ungrouped
tagquerystringNoUp to 20 comma-separated tag ids (all must match) (max length 800)
osquery"windows" | "linux"No
networkquery"direct" | "proxy" | "missing"No
sortquery"number" | "name" | "updated_at" | "created_at" | "last_opened_at" | "trashed_at"No
dirquery"asc" | "desc"No

Examples

curl "https://browlix.com/api/public/v1/profiles" \
  -H "Authorization: Bearer $BROWLIX_API_KEY"

Response

200 with { data, page, correlation_id }.

FieldTypeAlways presentDescription
dataarray<object>Yes
data[].idstring (uuid)Yes
data[].numberintegerYesWorkspace-wide profile number (min -9007199254740991, max 9007199254740991)
data[].namestringYes
data[].state"active" | "trashed"Yes
data[].revisionintegerYesSend as expected_revision when you change the profile (min -9007199254740991, max 9007199254740991)
data[].os"windows" | "linux"Yes
data[].kernelstringYes
data[].network_mode"direct" | "proxy"Yes
data[].groupobject | nullYes
data[].group.idstring (uuid)Yes
data[].group.namestringYes
data[].tagsarray<object>Yes
data[].tags[].idstring (uuid)Yes
data[].tags[].namestringYes
data[].tags[].colorstringYes
data[].proxyobject | nullYes
data[].proxy.idstring (uuid)Yes
data[].proxy.namestringYes
data[].proxy.scheme"http" | "https" | "socks5"Yes
data[].proxy.hoststringYes
data[].proxy.portintegerYes(min -9007199254740991, max 9007199254740991)
data[].proxy.last_checkobject | nullNo
data[].notesstringYes
data[].accountsintegerYesHow many platform accounts are stored on the profile (never their secrets) (min -9007199254740991, max 9007199254740991)
data[].created_atstring (date-time)Yes
data[].updated_atstring (date-time)Yes
data[].last_opened_atstring (date-time) | nullYes
data[].trashed_atstring (date-time) | nullYes
correlation_idstring (uuid)Yes
pageobjectNo
page.limitintegerNo
page.totalintegerNo
page.next_cursorstring | nullNo

New fields can appear at any time; ignore the ones you do not know.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations