# Smart lists API

> Smart lists in the Broker & Agent API: list smart lists; who is on a smart list.

Base URL: `https://workspace.brokerandagent.com/api/public/v1`. Every call needs an [API key or OAuth token](https://brokerandagent.com/developers/api/authentication).

- [List smart lists](#list-smart-lists): `GET /smart-lists`
- [Who is on a smart list](#who-is-on-a-smart-list): `GET /smart-lists/{id}/members`

## List smart lists

`GET /smart-lists`

The workspace's saved lists, or the built-in kit, with live counts over what the credential's person can see.

Scope: `crm.read`

```bash
curl https://workspace.brokerandagent.com/api/public/v1/smart-lists \
  -H "Authorization: Bearer bak_YOUR_KEY"
```

**Responses**

| Status | | Returns |
|---|---|---|
| `200` | Smart lists. | { `smartLists`: array of [SmartList](https://brokerandagent.com/developers/api/reference/objects#smartlist) } |
| `401` | No credential, or one that's unknown, expired or revoked (unauthorized); or the workspace is suspended (workspace_suspended). |  |
| `403` | The credential lacks the scope (insufficient_scope, naming it in `scope`), the record isn't the person's to change (forbidden), the connection wasn't granted that workspace (workspace_not_granted), or an assistant-only token called outside the assistant's tools (wrong_audience). |  |
| `429` | Too many requests for this credential; wait for Retry-After (rate_limited). |  |

## Who is on a smart list

`GET /smart-lists/{id}/members`

In the list's own order, each with why they're on it.

Scope: `crm.read`

**Parameters**

| Name | In | Type | |
|---|---|---|---|
| `id` (required) | path | string |  |
| `limit` | query | integer | How many to answer with, 1 to 100. Default `25`. |
| `cursor` | query | string or null | The `nextCursor` of the page before; absent for the first page. Cut to 200 characters. |

```bash
curl https://workspace.brokerandagent.com/api/public/v1/smart-lists/ID/members \
  -H "Authorization: Bearer bak_YOUR_KEY"
```

**Responses**

| Status | | Returns |
|---|---|---|
| `200` | A page of members. | { `smartList`: [SmartList](https://brokerandagent.com/developers/api/reference/objects#smartlist), `members`: array of [SmartListMember](https://brokerandagent.com/developers/api/reference/objects#smartlistmember), `nextCursor`: string or null } |
| `401` | No credential, or one that's unknown, expired or revoked (unauthorized); or the workspace is suspended (workspace_suspended). |  |
| `403` | The credential lacks the scope (insufficient_scope, naming it in `scope`), the record isn't the person's to change (forbidden), the connection wasn't granted that workspace (workspace_not_granted), or an assistant-only token called outside the assistant's tools (wrong_audience). |  |
| `404` | No such record, or one the credential's person can't see (not_found). |  |
| `422` | A field is the wrong kind or breaks a rule, named in the message (validation); or the Idempotency-Key was used for a different request (idempotency_key_reused). |  |
| `429` | Too many requests for this credential; wait for Retry-After (rate_limited). |  |

---

Source: https://brokerandagent.com/developers/api/reference/smart-lists
