跳到导航
ReceptionAssets

Get All Assets

List the workspace's bookable assets, such as rooms or equipment.

请求头

xi-api-keystring可选
xi-workspace-idstring or null可选
The customer workspace a reseller's API key acts on.

响应

成功响应

namestring

Internal/admin name of the asset, shown in the dashboard and owner notifications.

_idstring
groupslist of objects可选

Group memberships for this item. Each entry carries the group label and the item’s 0-based rank within that group.

ungrouped_rankinteger or null可选>=0

Display position among items with no group; null sorts last. Change it with the reorder endpoint.

descriptionstring可选
Description of the asset.
is_activeboolean可选默认为 true
Whether the asset can be booked. Inactive assets keep their booking history.
available_hoursobject or null可选

Custom availability hours for this asset. Null means follow the assigned location’s operating_hours (requires location_id).

photo_urlstring or null可选格式: "uri"1-2083 characters
URL of a photo of the asset.
location_idstring or null可选

Location this asset belongs to; empty means available at all locations.

customer_facing_namestring可选

Optional public-facing label. When empty, name is shown to customers too. name stays the internal/admin label used in the dashboard and business-owner notifications.

created_at_unixinteger可选

Unix timestamp (seconds since epoch)

updated_at_unixinteger可选

Unix timestamp (seconds since epoch)

错误

422
Unprocessable Entity Error