Newforma Konekt Web API 2026-10-05
Added:
The DisplayName property has been added to the HubDetail object. This property contains the display name of the hub, as chosen by the hub owner.
Until now, the only name exposed by the API was the Name property, which is the hub URL identifier: a normalized, lowercase, DNS-safe value used to build hub URLs.
When no display name has been set on a hub, DisplayName falls back to the value of Name, so the property is always populated.
Affected Endpoints:
The following endpoints are impacted by this change, as the response now includes the DisplayName property:
V3 Endpoints:
- Get hubs:
GET /v3/hubs - Get hub:
GET /v3/hubs/{hubId} - Get hub by name:
GET /v3/hubs/name/{hubName}
API Response Example:
{
"Id": "aB3x9kL2",
"Name": "acme-construction",
"DisplayName": "Acme Construction Inc.", // Newly added property
"Author": {
"Id": 2,
"UserName": "b8c0255a-e435-479b-8b92-0dd77c18f9b1",
"Email": "[email protected]",
"FirstName": "John",
"LastName": "Doe",
"AvatarUrl": "https://www.exampleUrl.com"
},
"Image": null,
"CreationDate": "2026-09-10T15:38:17.419Z",
"RegionSummary": {
"Location": "Canada",
"ApiRegionalUrl": "https://api.bimtrackapp.co"
},
"NumberOfUsers": 12,
"NumberOfProjects": 3,
"IsUserEntraIdSsoRestricted": false,
"RestrictedTenantId": null,
"RestrictedTenantDomain": null
}
Changed:
The documentation of the GET /v3/hubs/name/{hubName} endpoint has been clarified.
Despite its name, the hubName parameter expects the hub URL identifier (the Name property, as it appears in the hub URL), not the DisplayName. The behaviour of the endpoint is unchanged; only its description was corrected.
