PIpirros
Families

List families that nest the seed family

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).

get/v1/workspaces/{workspaceId}/families/{id}/nesting

Request

  • Base URL
    https://external-api.pirros.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.pirros.com/oauth/token

Path parameters

workspaceIdstring uuid required
idstring uuid required

Response

Nesting families (where-used)

Example response

{
  "response": {
    "data": [
      {
        "id": "f1a8e3d2-9c4b-4f7e-8a6d-1c3b5e7d9a02",
        "name": "Curtain-Wall-Type-A",
        "category": "Doors",
        "classification": "Architectural",
        "revit_version": "2024"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.