List or search workspace families
List families in a workspace. Without q, structured filters (tag, category, revit_version) run in SQL and the result is keyset-paginated by (created_at, id). With q, a free-text Algolia search runs (requires a broad family grant, else 403 free_text_requires_broad_access) with the same structured filters applied as facets. The cursor is opaque. With q, a cursor reused under a changed query resets to the first page. Without q, the cursor encodes ordering position only and continues from that position under the new filters; re-paginate from the start when filters change. revit_version matches a family’s available-version set (authored or successfully upgraded) and is normalized to a 4-digit year. An unrecognized revit_version (no standalone 4-digit year) matches nothing and returns an empty result — it is not rejected.
Request
- Base URLhttps://external-api.pirros.com
- AuthOAuth 2Client credentialsToken URL: https://auth.pirros.com/oauth/token
Path parameters
Query parameters
Response
Families list/search results
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.