---
title: "List families that nest the seed family"
method: GET
path: "/v1/workspaces/{workspaceId}/families/{id}/nesting"
tags: ["Families"]
---

# List families that nest the seed family

`GET /v1/workspaces/{workspaceId}/families/{id}/nesting`

## Request

- Base URL: `https://external-api.pirros.com`
- URL: `https://external-api.pirros.com/v1/workspaces/{workspaceId}/families/{id}/nesting`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.pirros.com/oauth/token`

Return the families that directly nest the seed family (where it is used), as recorded on the seed’s current version. Each entry is the referenced (parent) version’s summary — not re-resolved to that family’s current version. Mirrors the internal family-references view: not deduplicated (one entry per reference) and unordered. The seed family is resolved like the family GET (cross-workspace / cross-firm / missing / unmatched -> 404). Full-return: next_cursor is always null and ?cursor/?limit are rejected (reserved).

## Path parameters

- `workspaceId` string, uuid, required
- `id` string, uuid, required

## Response `200`

Nesting families (where-used)

- ExternalFamilyNestingResponse: Families that directly nest the seed family / where-used, as referenced on its current version (full-return; not deduplicated; next_cursor always null in v2)
  - `response` object, required
    - `data` ExternalFamilySummaryDto[], required
      - `id` string, uuid, required
      - `name` string, required
      - `category` string, required
      - `classification` string, required
      - `revit_version` string, required
    - `next_cursor` unknown, required
    - `expanded` object, required
  - `meta` object, required
    - `request_id` string, uuid, required

## Other responses

- `400`: Invalid request (bad path param, query param, or cursor)
- `401`: Unauthorized (invalid or missing token)
- `404`: Seed family not found in this workspace
- `429`: Rate limit exceeded (1000 requests per hour per client)
- `503`: External API temporarily disabled by operator kill switch (service_unavailable)

---

[API](https://skmtc.dev/pirros/apis/pirros-external-api.md) - [All operations](https://skmtc.dev/pirros/apis/pirros-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pirros/apis/pirros-external-api/revisions/01c66b8d9fd1?raw)