# Notes

Free text a human or an agent leaves on a lead.

Source: https://docs.leadarc.io/reference-notes.html

- [GET /v1/workspaces/{ws}/notes](#get-v1-workspaces-ws-notes)
- [POST /v1/workspaces/{ws}/notes](#post-v1-workspaces-ws-notes)

## GET /v1/workspaces/{ws}/notes

`notes:read` · read bucket · returns list of note

Notes, filterable by lead

```bash
curl -sS https://api.leadarc.io/v1/workspaces/airpay/notes?limit=25 \
  -H "Authorization: Bearer $LEADARC_API_KEY"
```

**Query parameters.** Anything else is [`400 unsupported_filter`](errors.html#status-400).

`author_id` `created_since` `cursor` `lead_id` `limit` `order`

**Errors from this endpoint**, on top of the [common ones](errors.html): [`invalid_cursor`](errors.html#status-400), [`invalid_request`](errors.html#status-400), [`not_found`](errors.html#status-404), [`unprocessable`](errors.html#status-422).

```json
{
  "object": "list",
  "data": [{
    "object": "note",
    "id": "note_WUtrkXxQzwp6F6u3aElmD79T9DmBtvGp7XpMqS",
    "workspace": "airpay",
    "lead_id": "lead_BP2vnPmKyttNP2OlH_mWL78t1o6nBVC6oVbHny",
    "reply_id": "rep_Dk9dw7dVABGNJm9HK9onvZKXLneRRpj9MIB-C3",
    "body": "Wants a walkthrough before their board meeting on the 8th.",
    "author_id": "usr_zaDRRpdu8EPZSU3i89lvZgKPkVQo4uBFA_KOhm",
    "created_at": "2026-07-27T09:26:00Z",
    "updated_at": "2026-07-27T09:26:00Z"
  }],
  "has_more": false,
  "next_cursor": null
}
```

## POST /v1/workspaces/{ws}/notes

`notes:write` · write bucket · returns note

Add a note to a lead

```bash
curl -sS https://api.leadarc.io/v1/workspaces/airpay/notes \
  -X POST \
  -H "Authorization: Bearer $LEADARC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lead_id":"lead_BP2vnPmKyttNP2OlH_mWL78t1o6nBVC6oVbHny","body":"..."}'
```

**Body fields.** An unknown field is rejected.

`lead_id` `body`

**Errors from this endpoint**, on top of the [common ones](errors.html): `invalid_cursor`, `invalid_request`, `not_found`, `unprocessable`.

```json
{
  "lead_id": "lead_BP2vnPmKyttNP2OlH_mWL78t1o6nBVC6oVbHny",
  "body": "Wants a walkthrough before their board meeting on the 8th."
}
```
`201` with the created [`note`](objects.html#note). `reply_id` is resolved to the lead's newest indexed reply. `author_id` is the key's owner.

**Not idempotent.** A retry creates a second note. The created object is returned so a caller can detect a duplicate.

---

---

Base URL `https://api.leadarc.io/v1`. Generated from the API source.