Skip to main content
GET
Get Resource

Get Resource

Returns the complete details for a single published resource, including configuration, pricing, images, and custom fields.

Authentication

No authentication required.

Path Parameters

resourceId
number
required
Numeric identifier of the resource.

Query Parameters

_shape
string
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,Description,ResourceTypeName,Price,PriceFormatted,Allocation.

Response

Returns a Resource object with the full resource configuration. See Resource Details for the complete field reference.

Identity

Core

Location

Pricing

Capacity & Booking Rules

Amenities

Availability

Floor Plan

Timestamps (from base)

Examples

Fetch a resource

TypeScript Integration