# List profiles

Returns profiles, one page at a time.

```http
GET https://api.pozy.ai/v1/profiles
```

- Area: Accounts & connections / Profiles
- Auth: Authorization: Bearer pz_live_...

## Query parameters

- `includeOverLimit` (boolean)
- `name` (string)
- `externalId` (string)
- `limit` (integer)
- `skip` (integer)

## Example request

```bash
curl -X GET "https://api.pozy.ai/v1/profiles?limit=1" \
  -H "Authorization: Bearer $POZY_API_KEY"
```

```ts
const res = await fetch("https://api.pozy.ai/v1/profiles?limit=1", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);
```

```python
import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/profiles",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "limit": 1,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())
```

## Response 200

- `profiles`, array of object
  - `_id`, string
  - `userId`, string
  - `name`, string
  - `description`, string
  - `color`, string
  - `timezone`, string: Can be null
  - `externalId`, string: Can be null
  - `isDefault`, boolean
  - `isOverLimit`, boolean
  - `accountCount`, integer
  - `createdAt`, string (date-time)
- `total`, integer
- `skip`, integer
- `limit`, integer

```json
{
  "profiles": [
    {
      "_id": "635d87e261ae344ef27fd1df",
      "userId": "6da95b9455a22c1e061837af",
      "name": "Acme",
      "description": "A short description",
      "color": "string",
      "timezone": "America/New_York",
      "externalId": "62c9d6bdf3fa891362623a67",
      "isDefault": true,
      "isOverLimit": true,
      "accountCount": 42,
      "createdAt": "2026-10-02T09:00:00.000Z"
    }
  ],
  "total": 42,
  "skip": 1,
  "limit": 1
}
```