PIpirros
Details

Search workspace details

Search details in a workspace. Customer filters (detail_type, tag, revit_version, q) narrow the result and AND-combine with the credential authorization filters. revit_version matches the detail’s available-version set via the availableRevitVersions facet and is normalized to a 4-digit year. Cursor-paginated; the cursor is opaque and resets to the first page when the query filters change. (Date filtering on details — created_after/created_before — is deferred past v1: the Algolia details index has no numeric createdAt to range-filter.) An unrecognized revit_version (no standalone 4-digit year) matches nothing and returns an empty result — it is not rejected. Authorization-filter attribute support is path-dependent: a detail resource filter on project_id is honored on the GET-by-id path but rejected with 400 (UNSUPPORTED_ALGOLIA_ATTRIBUTE) on this search path, and created_at is unsupported on both.

get/v1/workspaces/{workspaceId}/details

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

Query parameters

qstring
detail_typestring
tagstring
revit_versionstring
cursorstring
limitstring

Response

Detail search results

Example response

{
  "response": {
    "data": [
      {
        "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.