List media items (images, videos, raw files) for a building, unit, or unit type. Media items are organised into groups:
PROFESSIONAL, ONBOARDING, MAINTENANCE. Results are ordered by position within their group.
| Parameter |
Type |
Required |
Description |
entityType |
EntityType |
Yes |
The type of entity to list media items for. BUILDING for a building, UNIT for a unit (property), UNIT_TYPE for a unit type (multi-unit group). - EntityType |
entityId |
string |
Yes |
The ID of the entity |
filters |
unknown |
No |
Filter criteria for media items |
first |
number |
No |
Number of results to return (forward pagination). Maximum 25. |
after |
string |
No |
Cursor for forward pagination. Pass the endCursor from the previous page’s pageInfo. |
last |
number |
No |
Number of results to return (backward pagination). Maximum 25. |
before |
string |
No |
Cursor for backward pagination. Pass the startCursor from the previous page’s pageInfo. |
| Value |
Description |
BUILDING |
A building containing unit types and units |
UNIT |
A single accommodation unit |
UNIT_TYPE |
A unit type grouping multiple units |
| Field |
Type |
Description |
content |
ContentItem[] |
Array of content items returned by the tool - ContentItem |
isError |
boolean |
Whether the tool execution resulted in an error |
| Field |
Type |
Description |
type |
'text' |
Content type (currently only ‘text’ is supported) |
text |
string |
The text content to display |