PIpirros
Details

Get a workspace detail by ID

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

get/v1/workspaces/{workspaceId}/details/{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

Detail found

Example response

{
  "response": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "project_id": "550e8400-e29b-41d4-a716-446655440000",
    "view_name": "Foundation Plan - Level 1",
    "title_on_sheet": "Wall Section Detail",
    "detail_type": "Section",
    "detail_number": "3/A-101",
    "sheet_name": "Architectural Plans",
    "sheet_number": "A-101",
    "scale": "1/4\" = 1'-0\"",
    "pdf_url": "https://cdn.example.com/details/7c9e6679-7425-40de-944b-e07fc1f90ae7.pdf",
    "revit_version": "2024",
    "has_2d_elements": true,
    "is_downloadable": true,
    "notes": "Updated per latest code requirements",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-16T14:22:00Z"
  }
}

Changes

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