# parties.list

List customers and vendors (accounts) with their jurisdiction, tax treatment, open balance by currency, overdue count, and last invoice. Filter by search text or kind.

`GET | POST /api/v1/accounting/parties.list`

Permissions: `accounting:read` · Roles: admin, finance

MCP tool: `accounting_parties_list`

## Fields

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `search` | string |  | Text to search for. at most 200 characters. |
| `kind` | enum |  | Which kind of record or job this is. One of: `customer`, `vendor`, `both`. |
| `includeArchived` | boolean |  | Also include archived records. |
| `archivedOnly` | boolean |  |  |
| `limit` | integer |  | How many results to return at most. 1 to 200. Default `50`. |
| `offset` | integer |  | How many results to skip, for the next page of a list. 0 to 100000. Default `0`. |

## Example request

```bash
curl https://app.getoatmilk.com/api/v1/accounting/parties.list \
  -H "Authorization: Bearer $OATMILK_API_KEY"
```

Reference page: https://app.getoatmilk.com/docs/api/parties.list