# profiles.list

`GET /api/public/v1/profiles`

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

- Capability: `profile.read`
- Command: no
- Paginated: keyset (`limit`, `cursor` = `page.next_cursor`)
- MCP tool: `profiles_list`

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no | Page size (max 100) (min 1, max 100) Default: `50`. |
| `cursor` | query | string | no | page.next_cursor from the previous page (max length 400) |
| `state` | query | "active" \| "trashed" | no | Default: `"active"`. |
| `q` | query | string | no | Search name, number, notes (max length 120) |
| `group` | query | "none" \| string (uuid) | no | Group id, or none for ungrouped |
| `tag` | query | string | no | Up to 20 comma-separated tag ids (all must match) (max length 800) |
| `os` | query | "windows" \| "linux" | no |  |
| `network` | query | "direct" \| "proxy" \| "missing" | no |  |
| `sort` | query | "number" \| "name" \| "updated_at" \| "created_at" \| "last_opened_at" \| "trashed_at" | no |  |
| `dir` | query | "asc" \| "desc" | no |  |

## Response

`200` with `{ data, page, correlation_id }`.

| Field | Type | Always present | Description |
|---|---|---|---|
| `data` | array<object> | yes |  |
| `data[].id` | string (uuid) | yes |  |
| `data[].number` | integer | yes | Workspace-wide profile number (min -9007199254740991, max 9007199254740991) |
| `data[].name` | string | yes |  |
| `data[].state` | "active" \| "trashed" | yes |  |
| `data[].revision` | integer | yes | Send as expected_revision when you change the profile (min -9007199254740991, max 9007199254740991) |
| `data[].os` | "windows" \| "linux" | yes |  |
| `data[].kernel` | string | yes |  |
| `data[].network_mode` | "direct" \| "proxy" | yes |  |
| `data[].group` | object \| null | yes |  |
| `data[].group.id` | string (uuid) | yes |  |
| `data[].group.name` | string | yes |  |
| `data[].tags` | array<object> | yes |  |
| `data[].tags[].id` | string (uuid) | yes |  |
| `data[].tags[].name` | string | yes |  |
| `data[].tags[].color` | string | yes |  |
| `data[].proxy` | object \| null | yes |  |
| `data[].proxy.id` | string (uuid) | yes |  |
| `data[].proxy.name` | string | yes |  |
| `data[].proxy.scheme` | "http" \| "https" \| "socks5" | yes |  |
| `data[].proxy.host` | string | yes |  |
| `data[].proxy.port` | integer | yes | (min -9007199254740991, max 9007199254740991) |
| `data[].proxy.last_check` | object \| null | no |  |
| `data[].notes` | string | yes |  |
| `data[].accounts` | integer | yes | How many platform accounts are stored on the profile (never their secrets) (min -9007199254740991, max 9007199254740991) |
| `data[].created_at` | string (date-time) | yes |  |
| `data[].updated_at` | string (date-time) | yes |  |
| `data[].last_opened_at` | string (date-time) \| null | yes |  |
| `data[].trashed_at` | string (date-time) \| null | yes |  |
| `correlation_id` | string (uuid) | yes |  |
| `page` | object | no |  |
| `page.limit` | integer | no |  |
| `page.total` | integer | no |  |
| `page.next_cursor` | string \| null | no |  |

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

## Errors

| Code | HTTP | Retryable |
|---|---|---|
| `UNAUTHENTICATED` | 401 | no |
| `FORBIDDEN` | 403 | no |
| `RATE_LIMITED` | 429 | yes |
| `VALIDATION_FAILED` | 422 | no |
| `DEPENDENCY_UNAVAILABLE` | 503 | yes |
| `UNKNOWN` | 500 | no |

## Example (curl)

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

## Example (TypeScript SDK)

```ts
import { Browlix } from "@browlix/sdk";

const bx = new Browlix({ apiKey: process.env.BROWLIX_API_KEY! });
const reply = await bx.call("profiles.list");
console.log(reply.data);
```

## Example (Python)

```python
import os
import requests

r = requests.get(
    "https://browlix.com/api/public/v1/profiles",
    headers={"Authorization": f"Bearer {os.environ['BROWLIX_API_KEY']}"},
    timeout=60,
)
print(r.status_code, r.json())
```

## Example (MCP)

```json
{
  "method": "tools/call",
  "params": {
    "name": "profiles_list",
    "arguments": {}
  }
}
```