PIpirros
Families

Get a workspace family by ID

Retrieve a single family (current version) scoped to the workspace. A family in another workspace, an archived/missing family, and a family no granted filter matches all return 404 (indistinguishable — no existence disclosure).

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

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

Family found

Example response

{
  "response": {
    "id": "f1a8e3d2-9c4b-4f7e-8a6d-1c3b5e7d9a02",
    "current_version_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "version_number": 3,
    "name": "Curtain-Wall-Type-A",
    "category": "Doors",
    "parent_category": "Doors",
    "classification": "Architectural",
    "revit_version": "2024",
    "project_id": "9f5b3c2d-1ea8-4f2c-8a61-d1c9e54b03f1",
    "notes": "Updated mullion spacing",
    "is_downloadable": true,
    "read_only": false,
    "status": "ready",
    "failure_reason": null,
    "change_message": "Adjusted glazing thickness",
    "file_size": "2458123",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-02-01T14:22:00Z"
  }
}

Changes

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