PIpirros
Families

List families the seed family nests

Return the families the seed family directly nests (its one-hop children / what’s inside it), as recorded on the seed’s current version. Each entry is the referenced 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}/nested

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

Nested families

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.