List Resources
GET /reservables
List visible resources for a site or portal. Supply site_id for a site list or portal_id for a portal list. Private resources require appropriate access.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
site_id |
string | Conditional | Site ID for a site list. |
portal_id |
string | Conditional | Portal ID for a portal list. |
limit |
integer | null |
Page size. Supply limit and offset together. |
offset |
integer | null |
Number of rows to skip. Supply limit and offset together. |
attribs |
string | null |
Return specific attributes. Encode the + separator as %2B in the URL. |
alltag[] |
string | null |
Can be added more than once to filter on all tags provided |
Examples
Retrieve all resources for a site:
GET /reservables?site_id={site_id}
Retrieve specific properties (faster):
GET /reservables?site_id={site_id}&attribs=name%2Bdisclaimer
Response
Success Response (200 OK)
data contains a list of resource summaries by default. attribs selects the returned fields. The API also returns numitems. See Reservable Object for resource fields.
Error Responses
400 Bad Request: Invalid request or validation error401 Unauthorized: Authentication failed
See the Resources API overview for related endpoints and shared data structures.