---
title: "List accessible families"
method: GET
path: "/families"
tags: ["Families"]
---

# List accessible families

`GET /families`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/families`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Firm-side family relationships only. Select the firm with x-organization-id. Owners, Admins and Staff Admins access all firm families; Staff Members need independent family assignment. Company access does not grant family access. OAuth requires the broad mcp grant, not a narrow banking scope; API keys retain ordinary agent permission scopes. No accounting organizations, portal grants, bank changes, invitations or charges are created. Writes require ordinary firm write entitlement. Cross-firm and inaccessible IDs return 404.

## Query parameters

- `status` 'active' | 'archived'
- `search` string
- `page` integer
- `limit` integer

## Response `200`

Success

- object
  - `families` object[]
    - `id` string, uuid
    - `name` string
    - `firmOrganizationId` string, uuid
    - `companyCount` integer: Accessible linked company count, including archived companies, in directory responses
    - `archivedAt` string, date-time, nullable
    - `members` object[]
      - `id` string, uuid
      - `name` string
      - `email` string
      - `mobilePhone` string, nullable
      - `userId` string, uuid, nullable
      - `ownerContactId` string, uuid, nullable
    - `companies` object[]
      - `id` string, uuid
      - `name` string
      - `archived` boolean
    - `staff` object[]
      - `memberId` string, uuid
      - `name` string
      - `email` string
      - `role` string
  - `total` integer
  - `page` integer
  - `limit` integer

## Other responses

- `403`: Firm staff or required permission missing
- `404`: Record not found or not accessible
- `409`: Archived family, last-member removal, identity conflict, already-linked member, explicit owner selection required, or redundant administrator assignment

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)
