Resource Summary
Returns a lightweight summary of all published resources (desks, meeting rooms, offices, etc.) for the current location. Used for resource selectors and quick listings where full detail is not needed.
Authentication
No authentication required.
Query Parameters
Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation. Example: _shape=Name,ResourceTypeName,Id.
Response
Returns a ResourceSummaries object containing a lightweight summary of each published resource.
Resource Summary Fields
Identity
| Field | Type | Description |
|---|
Id | number | Unique numeric identifier for the resource |
UniqueId | string | Globally unique identifier |
Core
| Field | Type | Description |
|---|
Name | string | Resource display name (localised) |
Description | string | Resource description (localised) |
GroupName | string | Resource group name |
ResourceTypeName | string | Resource type display name (localised) |
Visible | boolean | Whether the resource is publicly visible |
DisplayOrder | number | Sort order in listings |
Location
| Field | Type | Description |
|---|
BusinessId | number | Location identifier |
BusinessName | string | Location display name |
BusinessWebAddress | string | Location subdomain |
| Field | Type | Description |
|---|
HasImage | boolean | Whether the resource has an image |
Timestamps (from base)
| Field | Type | Description |
|---|
CreatedOn | string | Date created (business-local time) |
UpdatedOn | string | null | Date last updated (business-local time) |
CreatedOnUtc | string | Date created (UTC) |
UpdatedOnUtc | string | null | Date last updated (UTC) |
Examples
Fetch resource summaries
GET /api/public/resources/published/summary
TypeScript Integration
import endpoints from '@/api/endpoints'
const { resource: summaries } = useTypedData(httpClient, endpoints.resources.summary())
