Download OpenAPI specification:
Read and manage a Solidres site's properties, room types, extras, coupons and reference data, and read its reservations and payments.
The Solidres REST API runs on Joomla's Web Services: every route below sits under your site's
/api/index.php, speaks JSON:API, and is switched on by the
Web Services - Solidres plugin.
Send a Joomla API token with every request, in an X-Joomla-Token header or as
Authorization: Bearer <token>. A user finds their token on their profile in the
administrator (Joomla API Token tab). A user can hold a token when the User - Joomla API
token plugin allows their group, and can use it when their group has API Login
(core.login.api) in Global Configuration. Without a valid token every route answers 401.
The exception is the public routes, under /v1/solidres/public/: what a guest sees and
books on the site, served to anyone without a token (Public properties, Public booking).
They are off until Public booking API is switched on in Solidres Options (Integrations);
until then they answer 404. A token sent to them changes nothing: they answer every caller
alike. They are rate limited per client address and per property: a request over a limit
answers 429 with a Retry-After header, and is not served (the limits are in Solidres
Options, Integrations). The site serves their description alone, as an OpenAPI document of its
own with the site as the server, at GET /v1/solidres/public/openapi.
Send Accept: application/vnd.api+json. Request bodies are plain JSON objects of the row's
fields (Content-Type: application/json), not JSON:API documents.
Two audiences use the API, and the same token works for both: the API decides by who the token belongs to.
core.manage) on Solidres,
Super Users among them. A manager reads every row of every resource.Both audiences are shown the same fields. Some fields are never shown to anyone: what a
payment gateway reported (payment_data) and a guest's feedback key (token).
Who may write is described with each resource.
A list answers a page of rows. page[limit] sets the page size (default: the site's list
length, usually 20) and page[offset] the first row (from 0). When there is more than one
page, links carries first, previous, next and last; meta.total-pages counts the
pages. filter[…] narrows a list and list[ordering] / list[direction] sort it.
data[].id and in relationships are strings; ids in attributes are integers."120.000000") unless a field says otherwise.YYYY-MM-DD, and times YYYY-MM-DD hh:mm:ss in UTC.params, metadata, reservation_meta) that holds nothing is sent
as an empty array, [].An error answers a JSON:API errors array, each entry with a title and, mostly, the
HTTP status as code: 400 for a row that does not validate (the title lists what is
wrong), 401 for a missing or invalid token, 403 for a write the caller may not make, 404
for a row that does not exist or that the caller may not read, and 500 for a failure on
the site. Deleting a row that does not exist answers 404 to a caller allowed to delete, and
403, as for any row they may not delete, to anyone else.
Property types: the categories of com_solidres. These routes are Joomla's own categories controller, scoped to Solidres' categories, so they behave as Joomla's /v1/content/categories does.
Who reads what. Any user who may use the API reads them.
Who writes. Joomla's permissions on Solidres' categories decide.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "categories",
- "id": "string",
- "attributes": {
- "id": 0,
- "title": "string",
- "alias": "string",
- "note": "string",
- "published": 0,
- "access": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_user_id": 0,
- "parent_id": 0,
- "level": 0,
- "lft": 0,
- "rgt": 0,
- "language": "string",
- "description": "string",
- "language_title": "string",
- "language_image": "string",
- "editor": "string",
- "access_level": "string",
- "author_name": "string"
}
}
], - "meta": {
- "total-pages": 0
}
}| title required | string Title. |
| alias | string URL alias; made from the title when left out. |
| parent_id | integer Id of the parent category; 1 for the root. |
| published | integer Publishing state. |
| description | string Description (HTML). |
| language | string Language tag, or |
| property name* additional property | any |
{- "title": "Boutique hotel",
- "published": 1
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "categories",
- "id": "string",
- "attributes": {
- "id": 0,
- "title": "string",
- "alias": "string",
- "note": "string",
- "published": 0,
- "access": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_user_id": 0,
- "parent_id": 0,
- "level": 0,
- "lft": 0,
- "rgt": 0,
- "language": "string",
- "description": "string",
- "extension": "com_solidres",
- "params": { }
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "categories",
- "id": "string",
- "attributes": {
- "id": 0,
- "title": "string",
- "alias": "string",
- "note": "string",
- "published": 0,
- "access": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_user_id": 0,
- "parent_id": 0,
- "level": 0,
- "lft": 0,
- "rgt": 0,
- "language": "string",
- "description": "string",
- "extension": "com_solidres",
- "params": { }
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| title | string Title. |
| alias | string URL alias; made from the title when left out. |
| parent_id | integer Id of the parent category; 1 for the root. |
| published | integer Publishing state. |
| description | string Description (HTML). |
| language | string Language tag, or |
| property name* additional property | any |
{- "title": "string",
- "alias": "string",
- "parent_id": 0,
- "published": 0,
- "description": "string",
- "language": "string"
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "categories",
- "id": "string",
- "attributes": {
- "id": 0,
- "title": "string",
- "alias": "string",
- "note": "string",
- "published": 0,
- "access": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_user_id": 0,
- "parent_id": 0,
- "level": 0,
- "lft": 0,
- "rgt": 0,
- "language": "string",
- "description": "string",
- "extension": "com_solidres",
- "params": { }
}
}
}Only a trashed category (published -2) can be deleted. Joomla answers a category it will not delete in its own JSON format, not with JSON:API errors.
| id required | integer >= 1 The row id. |
{- "errors": [
- {
- "title": "Forbidden"
}
]
}Properties: the hotels, apartments, hostels and other places a site takes bookings for.
Who reads what. A manager (a user allowed Access Administration Interface, core.manage, on Solidres) reads every row. Anyone else reads the rows of the properties they are the partner or a staff member of on a Hub site, in any state, and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. A user with Joomla's Create, Edit or Delete permission on Solidres writes any property. On a Hub site a partner also adds properties, which are theirs (and await approval where the site asks for it), and edits and deletes their own. In a partner's write the fields only an administrator sets are ignored and keep their stored values: partner_id, default, approved, access, created_by, created_date, commission_rate_id, params.commission_balance_due_date, staffs and the menu item fields.
Staff. staffs replaces a property's staff list: [{"staff_id": <user id>, "staff_group_id": [<group id>, …]}]. It is read only when sent, only from a user with Joomla's Edit (or, for a new property, Create) permission, and a user who holds Super User rights can be named only by a Super User. A staff member's groups change by the partner groups listed; their other groups stay.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[state] | integer Only rows in this publishing state (reservations: in this status code). |
| filter[category] | integer Only properties in this category. |
| filter[author] | integer Only properties created by this user. |
| filter[tag] | integer Only properties with this tag. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "reservationassets",
- "id": "string",
- "attributes": {
- "id": 0,
- "asset_id": 0,
- "name": "string",
- "alternative_name": "string",
- "alias": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "postcode": "string",
- "phone": "string",
- "description": "string",
- "email": "string",
- "website": "string",
- "featured": 0,
- "fax": "string",
- "rating": 0,
- "geo_state_id": 0,
- "country_id": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_date": "2026-10-17 08:30:00",
- "created_by": 0,
- "modified_by": 0,
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "ordering": 0,
- "archived": 0,
- "approved": 0,
- "access": 0,
- "params": { },
- "language": "string",
- "hits": 0,
- "metatitle": "string",
- "metakey": "string",
- "metadesc": "string",
- "partner_id": 0,
- "lat": "120.000000",
- "lng": "120.000000",
- "default": 0,
- "deposit_required": 0,
- "deposit_is_percentage": 0,
- "deposit_amount": "120.000000",
- "deposit_by_stay_length": 0,
- "deposit_include_extra_cost": 0,
- "currency_id": 0,
- "tax_id": 0,
- "booking_type": 0,
- "price_includes_tax": 0,
- "distance_from_city_centre": "120.000000",
- "tab_content": "string",
- "country_name": "string",
- "geostate_name": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "metadata": "string",
- "parent_category_title": "string",
- "parent_category_id": 0,
- "parent_category_uid": 0,
- "parent_category_level": 0,
- "number_of_roomtype": 0
}, - "relationships": {
- "category": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "tags": {
- "data": [
- {
- "type": "string",
- "id": "string"
}
]
}, - "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "partner_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "currency_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
], - "meta": {
- "total-pages": 0
}
}On a database in strict mode the text columns have no default, so send address_1, address_2, city, postcode, phone, description, website, fax, language, params and metadata too (empty strings and objects will do).
| name required | string Name. |
| category_id required | integer Id of its category ( |
| email required | string Email address bookings are notified to. |
| country_id required | integer Id of its country. |
| currency_id required | integer Id of its currency. |
| default | integer 1 to make it the site's default property. |
| state | integer Publishing state. |
| address_1 | string Address, first line. |
| address_2 | string Address, second line. |
| city | string City. |
| postcode | string Postcode. |
| phone | string Phone number. |
| description | string Description (HTML). |
| website | string Website URL. |
| fax | string Fax number. |
| language | string Language tag, or |
| params | object Property settings; see |
| metadata | object Search engine metadata. |
| staffs | Array of arrays The property's staff list (see above). |
| property name* additional property | any |
{- "name": "Harbour View Hotel",
- "category_id": 3,
- "email": "stay@harbourview.example",
- "country_id": 224,
- "currency_id": 1,
- "default": 0,
- "state": 1,
- "address_1": "1 Quay Street",
- "address_2": "",
- "city": "Portsmouth",
- "postcode": "PO1 2AB",
- "phone": "+44 23 9200 0000",
- "description": "",
- "website": "",
- "fax": "",
- "language": "*",
- "params": {
- "is_apartment": 0
}, - "metadata": {
- "robots": ""
}
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "reservationassets",
- "id": "string",
- "attributes": {
- "id": 0,
- "asset_id": 0,
- "name": "string",
- "alternative_name": "string",
- "alias": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "postcode": "string",
- "phone": "string",
- "description": "string",
- "email": "string",
- "website": "string",
- "featured": 0,
- "fax": "string",
- "rating": 0,
- "geo_state_id": 0,
- "country_id": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_date": "2026-10-17 08:30:00",
- "created_by": 0,
- "modified_by": 0,
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "ordering": 0,
- "archived": 0,
- "approved": 0,
- "access": 0,
- "params": { },
- "language": "string",
- "hits": 0,
- "metatitle": "string",
- "metakey": "string",
- "metadesc": "string",
- "partner_id": 0,
- "lat": "120.000000",
- "lng": "120.000000",
- "default": 0,
- "deposit_required": 0,
- "deposit_is_percentage": 0,
- "deposit_amount": "120.000000",
- "deposit_by_stay_length": 0,
- "deposit_include_extra_cost": 0,
- "currency_id": 0,
- "tax_id": 0,
- "booking_type": 0,
- "price_includes_tax": 0,
- "distance_from_city_centre": "120.000000",
- "tab_content": "string",
- "country_name": "string",
- "geostate_name": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "metadata": { }
}, - "relationships": {
- "category": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "tags": {
- "data": [
- {
- "type": "string",
- "id": "string"
}
]
}, - "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "partner_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "currency_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "reservationassets",
- "id": "string",
- "attributes": {
- "id": 0,
- "asset_id": 0,
- "name": "string",
- "alternative_name": "string",
- "alias": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "postcode": "string",
- "phone": "string",
- "description": "string",
- "email": "string",
- "website": "string",
- "featured": 0,
- "fax": "string",
- "rating": 0,
- "geo_state_id": 0,
- "country_id": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_date": "2026-10-17 08:30:00",
- "created_by": 0,
- "modified_by": 0,
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "ordering": 0,
- "archived": 0,
- "approved": 0,
- "access": 0,
- "params": { },
- "language": "string",
- "hits": 0,
- "metatitle": "string",
- "metakey": "string",
- "metadesc": "string",
- "partner_id": 0,
- "lat": "120.000000",
- "lng": "120.000000",
- "default": 0,
- "deposit_required": 0,
- "deposit_is_percentage": 0,
- "deposit_amount": "120.000000",
- "deposit_by_stay_length": 0,
- "deposit_include_extra_cost": 0,
- "currency_id": 0,
- "tax_id": 0,
- "booking_type": 0,
- "price_includes_tax": 0,
- "distance_from_city_centre": "120.000000",
- "tab_content": "string",
- "country_name": "string",
- "geostate_name": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "metadata": { }
}, - "relationships": {
- "category": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "tags": {
- "data": [
- {
- "type": "string",
- "id": "string"
}
]
}, - "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "partner_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "currency_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| name | string Name. |
| category_id | integer Id of its category ( |
string Email address bookings are notified to. | |
| country_id | integer Id of its country. |
| currency_id | integer Id of its currency. |
| default | integer 1 to make it the site's default property. |
| state | integer Publishing state. |
| address_1 | string Address, first line. |
| address_2 | string Address, second line. |
| city | string City. |
| postcode | string Postcode. |
| phone | string Phone number. |
| description | string Description (HTML). |
| website | string Website URL. |
| fax | string Fax number. |
| language | string Language tag, or |
| params | object Property settings; see |
| metadata | object Search engine metadata. |
| staffs | Array of arrays The property's staff list (see above). |
| property name* additional property | any |
{- "name": "string",
- "category_id": 0,
- "email": "string",
- "country_id": 0,
- "currency_id": 0,
- "default": 0,
- "state": 0,
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "postcode": "string",
- "phone": "string",
- "description": "string",
- "website": "string",
- "fax": "string",
- "language": "string",
- "params": { },
- "metadata": { },
- "staffs": [ ]
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "reservationassets",
- "id": "string",
- "attributes": {
- "id": 0,
- "asset_id": 0,
- "name": "string",
- "alternative_name": "string",
- "alias": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "postcode": "string",
- "phone": "string",
- "description": "string",
- "email": "string",
- "website": "string",
- "featured": 0,
- "fax": "string",
- "rating": 0,
- "geo_state_id": 0,
- "country_id": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_date": "2026-10-17 08:30:00",
- "created_by": 0,
- "modified_by": 0,
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "ordering": 0,
- "archived": 0,
- "approved": 0,
- "access": 0,
- "params": { },
- "language": "string",
- "hits": 0,
- "metatitle": "string",
- "metakey": "string",
- "metadesc": "string",
- "partner_id": 0,
- "lat": "120.000000",
- "lng": "120.000000",
- "default": 0,
- "deposit_required": 0,
- "deposit_is_percentage": 0,
- "deposit_amount": "120.000000",
- "deposit_by_stay_length": 0,
- "deposit_include_extra_cost": 0,
- "currency_id": 0,
- "tax_id": 0,
- "booking_type": 0,
- "price_includes_tax": 0,
- "distance_from_city_centre": "120.000000",
- "tab_content": "string",
- "country_name": "string",
- "geostate_name": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "metadata": { }
}, - "relationships": {
- "category": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "tags": {
- "data": [
- {
- "type": "string",
- "id": "string"
}
]
}, - "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "partner_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "currency_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Room types: what a property lets, each with its rooms and rate plans.
Who reads what. A manager (a user allowed Access Administration Interface, core.manage, on Solidres) reads every row. Anyone else reads the rows of the properties they are the partner or a staff member of on a Hub site, in any state, and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. A user with Joomla's Create, Edit or Delete permission on Solidres writes any row. On a Hub site a partner or staff member also writes the rows of their own properties: they may add a row to, edit, move between and delete rows in those properties. A write that names any other property (reservation_asset_id) is refused with 403 and changes nothing.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[published] | integer Only rows in this publishing state. |
| filter[reservation_asset_id] | integer Only rows of this property. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "roomtypes",
- "id": "string",
- "attributes": {
- "id": 0,
- "reservation_asset_id": 0,
- "name": "string",
- "alias": "string",
- "description": "string",
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_by": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_by": 0,
- "modified_date": "2026-10-17 08:30:00",
- "language": "string",
- "params": { },
- "featured": 0,
- "ordering": 0,
- "occupancy_max": 0,
- "occupancy_adult": 0,
- "occupancy_child": 0,
- "occupancy_child_age_range": 0,
- "smoking": 0,
- "is_private": 0,
- "is_master": 0,
- "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "number_of_room": 0
}, - "relationships": {
- "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
], - "meta": {
- "total-pages": 0
}
}On a database in strict mode send description and params too.
| reservation_asset_id required | integer Id of its property. |
| name required | string Name. |
| alias | string URL alias. |
| description | string Description (HTML). |
| state | integer Publishing state. |
| language | string Language tag, or |
| params | object Room type settings; see |
| occupancy_adult | integer Most adults a room takes. |
| occupancy_child | integer Most children a room takes. |
| occupancy_max | integer Most guests a room takes; 0 for no overall limit. |
| is_private | integer 1 when a room is let whole. |
| default_tariff required | object or array The default rate plan's prices: |
| property name* additional property | any |
{- "reservation_asset_id": 12,
- "name": "Superior Ocean View",
- "state": 1,
- "description": "",
- "language": "*",
- "params": {
- "show_adult_option": 1
}, - "occupancy_adult": 2,
- "occupancy_child": 1,
- "default_tariff": {
- "0": {
- "0": [
- 155,
- 155,
- 155,
- 155,
- 166,
- 166,
- 155
]
}
}
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "roomtypes",
- "id": "string",
- "attributes": {
- "id": 0,
- "reservation_asset_id": 0,
- "name": "string",
- "alias": "string",
- "description": "string",
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_by": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_by": 0,
- "modified_date": "2026-10-17 08:30:00",
- "language": "string",
- "params": { },
- "featured": 0,
- "ordering": 0,
- "occupancy_max": 0,
- "occupancy_adult": 0,
- "occupancy_child": 0,
- "occupancy_child_age_range": 0,
- "smoking": 0,
- "is_private": 0,
- "is_master": 0,
- "media": [
- {
- "image": "string",
- "thumb": "string"
}
]
}, - "relationships": {
- "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "roomtypes",
- "id": "string",
- "attributes": {
- "id": 0,
- "reservation_asset_id": 0,
- "name": "string",
- "alias": "string",
- "description": "string",
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_by": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_by": 0,
- "modified_date": "2026-10-17 08:30:00",
- "language": "string",
- "params": { },
- "featured": 0,
- "ordering": 0,
- "occupancy_max": 0,
- "occupancy_adult": 0,
- "occupancy_child": 0,
- "occupancy_child_age_range": 0,
- "smoking": 0,
- "is_private": 0,
- "is_master": 0,
- "media": [
- {
- "image": "string",
- "thumb": "string"
}
]
}, - "relationships": {
- "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| reservation_asset_id | integer Id of its property. |
| name | string Name. |
| alias | string URL alias. |
| description | string Description (HTML). |
| state | integer Publishing state. |
| language | string Language tag, or |
| params | object Room type settings; see |
| occupancy_adult | integer Most adults a room takes. |
| occupancy_child | integer Most children a room takes. |
| occupancy_max | integer Most guests a room takes; 0 for no overall limit. |
| is_private | integer 1 when a room is let whole. |
| default_tariff | object or array The default rate plan's prices: |
| property name* additional property | any |
{- "reservation_asset_id": 0,
- "name": "string",
- "alias": "string",
- "description": "string",
- "state": 0,
- "language": "string",
- "params": { },
- "occupancy_adult": 0,
- "occupancy_child": 0,
- "occupancy_max": 0,
- "is_private": 0,
- "default_tariff": { }
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "roomtypes",
- "id": "string",
- "attributes": {
- "id": 0,
- "reservation_asset_id": 0,
- "name": "string",
- "alias": "string",
- "description": "string",
- "state": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "created_by": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_by": 0,
- "modified_date": "2026-10-17 08:30:00",
- "language": "string",
- "params": { },
- "featured": 0,
- "ordering": 0,
- "occupancy_max": 0,
- "occupancy_adult": 0,
- "occupancy_child": 0,
- "occupancy_child_age_range": 0,
- "smoking": 0,
- "is_private": 0,
- "is_master": 0,
- "media": [
- {
- "image": "string",
- "thumb": "string"
}
]
}, - "relationships": {
- "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Currencies prices are quoted and charged in.
Who reads what. A manager (core.manage on Solidres) reads every row. Anyone else reads the published rows (state 1) and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. Joomla's permissions on Solidres decide: Create (core.create) to add, Edit (core.edit) to change, Delete (core.delete) to delete.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "currencies",
- "id": "string",
- "attributes": {
- "id": 0,
- "currency_name": "string",
- "currency_code": "string",
- "sign": "string",
- "exchange_rate": 0,
- "state": 0,
- "filter_range": "string"
}
}
], - "meta": {
- "total-pages": 0
}
}| currency_name required | string Name. |
| currency_code required | string ISO 4217 code; anything else is refused. |
| sign required | string Symbol. |
| exchange_rate required | number Rate against the site's default currency. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "currency_name": "Vietnamese dong",
- "currency_code": "VND",
- "sign": "₫",
- "exchange_rate": 0.00004,
- "state": 1
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "currencies",
- "id": "string",
- "attributes": {
- "id": 0,
- "currency_name": "string",
- "currency_code": "string",
- "sign": "string",
- "exchange_rate": 0,
- "state": 0,
- "filter_range": "string"
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "currencies",
- "id": "string",
- "attributes": {
- "id": 0,
- "currency_name": "string",
- "currency_code": "string",
- "sign": "string",
- "exchange_rate": 0,
- "state": 0,
- "filter_range": "string"
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| currency_name | string Name. |
| currency_code | string ISO 4217 code; anything else is refused. |
| sign | string Symbol. |
| exchange_rate | number Rate against the site's default currency. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "currency_name": "string",
- "currency_code": "string",
- "sign": "string",
- "exchange_rate": 0,
- "state": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "currencies",
- "id": "string",
- "attributes": {
- "id": 0,
- "currency_name": "string",
- "currency_code": "string",
- "sign": "string",
- "exchange_rate": 0,
- "state": 0,
- "filter_range": "string"
}
}
}Countries addresses and taxes refer to.
Who reads what. A manager (core.manage on Solidres) reads every row. Anyone else reads the published rows (state 1) and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. Joomla's permissions on Solidres decide: Create (core.create) to add, Edit (core.edit) to change, Delete (core.delete) to delete.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "countries",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "code_2": "string",
- "code_3": "string",
- "state": 0,
- "is_default": 0
}
}
], - "meta": {
- "total-pages": 0
}
}| name required | string Name. |
| code_2 required | string ISO 3166-1 alpha-2 code. |
| code_3 required | string ISO 3166-1 alpha-3 code. |
| state | integer Publishing state. |
| is_default | integer 1 for the country forms preselect. |
| property name* additional property | any |
{- "name": "Afghanistan",
- "code_2": "AF",
- "code_3": "AFG",
- "state": 1,
- "is_default": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "countries",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "code_2": "string",
- "code_3": "string",
- "state": 0,
- "is_default": 0
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "countries",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "code_2": "string",
- "code_3": "string",
- "state": 0,
- "is_default": 0
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| name | string Name. |
| code_2 | string ISO 3166-1 alpha-2 code. |
| code_3 | string ISO 3166-1 alpha-3 code. |
| state | integer Publishing state. |
| is_default | integer 1 for the country forms preselect. |
| property name* additional property | any |
{- "name": "string",
- "code_2": "string",
- "code_3": "string",
- "state": 0,
- "is_default": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "countries",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "code_2": "string",
- "code_3": "string",
- "state": 0,
- "is_default": 0
}
}
}States, provinces and regions of a country.
Who reads what. A manager (core.manage on Solidres) reads every row. Anyone else reads the published rows (state 1) and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. Joomla's permissions on Solidres decide: Create (core.create) to add, Edit (core.edit) to change, Delete (core.delete) to delete.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[country_id] | integer Only states of this country. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "states",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "country_id": 0,
- "code_2": "string",
- "code_3": "string",
- "state": 0
}, - "relationships": {
- "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
], - "meta": {
- "total-pages": 0
}
}| name required | string Name. |
| country_id required | integer Id of its country. |
| code_2 required | string Two-character code. |
| code_3 required | string Three-character code. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "A Coruña",
- "code_2": "15",
- "code_3": "ACO",
- "state": 1,
- "country_id": 156
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "states",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "country_id": 0,
- "code_2": "string",
- "code_3": "string",
- "state": 0
}, - "relationships": {
- "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "states",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "country_id": 0,
- "code_2": "string",
- "code_3": "string",
- "state": 0
}, - "relationships": {
- "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| name | string Name. |
| country_id | integer Id of its country. |
| code_2 | string Two-character code. |
| code_3 | string Three-character code. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "string",
- "country_id": 0,
- "code_2": "string",
- "code_3": "string",
- "state": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "states",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "country_id": 0,
- "code_2": "string",
- "code_3": "string",
- "state": 0
}, - "relationships": {
- "country_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Where bookings come from: the website, the phone, a walk-in, a channel.
Who reads what. A manager (core.manage on Solidres) reads every row. Anyone else reads the published rows (state 1) and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. Joomla's permissions on Solidres decide: Create (core.create) to add, Edit (core.edit) to change, Delete (core.delete) to delete.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[tax_id] | integer Only origins with this tax. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "origins",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "color": "string",
- "tax_id": 0,
- "is_default": 0,
- "state": 0
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
], - "meta": {
- "total-pages": 0
}
}| name required | string Name. |
| color required | string CSS colour. |
| tax_id | integer Id of a tax applied to its bookings. |
| is_default | integer 1 for the origin new bookings get. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "Travel agent",
- "state": 1,
- "is_default": 0,
- "color": "#41B3A3"
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "origins",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "color": "string",
- "tax_id": 0,
- "is_default": 0,
- "state": 0
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "origins",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "color": "string",
- "tax_id": 0,
- "is_default": 0,
- "state": 0
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| name | string Name. |
| color | string CSS colour. |
| tax_id | integer Id of a tax applied to its bookings. |
| is_default | integer 1 for the origin new bookings get. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "string",
- "color": "string",
- "tax_id": 0,
- "is_default": 0,
- "state": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "origins",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "color": "string",
- "tax_id": 0,
- "is_default": 0,
- "state": 0
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Discount codes guests enter when booking. A coupon linked to no property applies to every property and is read by managers only.
Who reads what. A manager (a user allowed Access Administration Interface, core.manage, on Solidres) reads every row. Anyone else reads the rows of the properties they are the partner or a staff member of on a Hub site, in any state, and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. Joomla's permissions on Solidres decide: Create (core.create) to add, Edit (core.edit) to change, Delete (core.delete) to delete.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[reservation_asset_id] | integer Only rows of this property. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "coupons",
- "id": "string",
- "attributes": {
- "id": 0,
- "coupon_name": "string",
- "coupon_code": "string",
- "amount": 0,
- "reservation_asset_id": 0,
- "is_percent": 0,
- "valid_from": "2026-10-17",
- "valid_to": "2026-10-17",
- "valid_from_checkin": "2026-10-17",
- "valid_to_checkin": "2026-10-17",
- "customer_group_id": 0,
- "state": 0,
- "quantity": 0,
- "params": {
- "image": "string",
- "article": "string"
}
}
}
], - "meta": {
- "total-pages": 0
}
}| coupon_name required | string Name. |
| coupon_code required | string The code a guest enters. |
| amount required | number Discount: an amount, or a percentage when |
| is_percent | integer 1 when |
| reservation_asset_id | Array of integers Ids of the properties it applies to; an empty list for every property. A change that leaves it out keeps them. |
| valid_from | string First day the code can be used ( |
| valid_to | string Last day the code can be used. |
| valid_from_checkin | string Earliest check-in date it applies to. |
| valid_to_checkin | string Latest check-in date it applies to. |
| quantity | integer How many times it can be used. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "coupon_name": "Spring 10",
- "coupon_code": "SPRING10",
- "amount": 10,
- "is_percent": 1,
- "reservation_asset_id": [
- 12
], - "valid_from": "2027-03-01",
- "valid_to": "2027-05-31",
- "quantity": 100,
- "state": 1
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "coupons",
- "id": "string",
- "attributes": {
- "id": 0,
- "coupon_name": "string",
- "coupon_code": "string",
- "amount": 0,
- "reservation_asset_id": 0,
- "is_percent": 0,
- "valid_from": "2026-10-17",
- "valid_to": "2026-10-17",
- "valid_from_checkin": "2026-10-17",
- "valid_to_checkin": "2026-10-17",
- "customer_group_id": 0,
- "state": 0,
- "quantity": 0,
- "params": {
- "image": "string",
- "article": "string"
}
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "coupons",
- "id": "string",
- "attributes": {
- "id": 0,
- "coupon_name": "string",
- "coupon_code": "string",
- "amount": 0,
- "reservation_asset_id": 0,
- "is_percent": 0,
- "valid_from": "2026-10-17",
- "valid_to": "2026-10-17",
- "valid_from_checkin": "2026-10-17",
- "valid_to_checkin": "2026-10-17",
- "customer_group_id": 0,
- "state": 0,
- "quantity": 0,
- "params": {
- "image": "string",
- "article": "string"
}
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| coupon_name | string Name. |
| coupon_code | string The code a guest enters. |
| amount | number Discount: an amount, or a percentage when |
| is_percent | integer 1 when |
| reservation_asset_id | Array of integers Ids of the properties it applies to; an empty list for every property. A change that leaves it out keeps them. |
| valid_from | string First day the code can be used ( |
| valid_to | string Last day the code can be used. |
| valid_from_checkin | string Earliest check-in date it applies to. |
| valid_to_checkin | string Latest check-in date it applies to. |
| quantity | integer How many times it can be used. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "coupon_name": "string",
- "coupon_code": "string",
- "amount": 0,
- "is_percent": 0,
- "reservation_asset_id": [
- 0
], - "valid_from": "string",
- "valid_to": "string",
- "valid_from_checkin": "string",
- "valid_to_checkin": "string",
- "quantity": 0,
- "state": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "coupons",
- "id": "string",
- "attributes": {
- "id": 0,
- "coupon_name": "string",
- "coupon_code": "string",
- "amount": 0,
- "reservation_asset_id": 0,
- "is_percent": 0,
- "valid_from": "2026-10-17",
- "valid_to": "2026-10-17",
- "valid_from_checkin": "2026-10-17",
- "valid_to_checkin": "2026-10-17",
- "customer_group_id": 0,
- "state": 0,
- "quantity": 0,
- "params": {
- "image": "string",
- "article": "string"
}
}
}
}Extras guests can add to a booking: breakfast, parking, a transfer.
Who reads what. A manager (a user allowed Access Administration Interface, core.manage, on Solidres) reads every row. Anyone else reads the rows of the properties they are the partner or a staff member of on a Hub site, in any state, and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. A user with Joomla's Create, Edit or Delete permission on Solidres writes any row. On a Hub site a partner or staff member also writes the rows of their own properties: they may add a row to, edit, move between and delete rows in those properties. A write that names any other property (reservation_asset_id) is refused with 403 and changes nothing.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[reservation_asset_id] | integer Only rows of this property. |
| filter[access][] | Array of integers Only extras with one of these access levels. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "extras",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "charge_type": 0,
- "max_quantity": 0,
- "daily_chargable": 0,
- "reservation_asset_id": 0,
- "state": 0,
- "access": 0,
- "price_includes_tax": 0,
- "description": "string",
- "tax_id": 0,
- "params": {
- "image": "string",
- "article": "string"
}, - "price": "120.000000",
- "price_adult": "120.000000",
- "price_child": "120.000000"
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
], - "meta": {
- "total-pages": 0
}
}On a database in strict mode send description and params too.
| name required | string Name. |
| reservation_asset_id required | integer Id of its property. |
| charge_type | integer How it is charged (see |
| price | number Price. |
| price_adult | number Price per adult. |
| price_child | number Price per child. |
| max_quantity | integer Most a guest can add. |
| daily_chargable | integer 1 to charge it per night. |
| tax_id | integer Id of the tax it is subject to. |
| coupon_id | Array of integers Ids of the coupons that apply to it; an empty list for none. A change that leaves it out keeps them. |
| description | string Description (HTML). |
| params | object Settings; see |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "Breakfast",
- "reservation_asset_id": 12,
- "charge_type": 5,
- "price": 0,
- "price_adult": 18,
- "price_child": 9,
- "max_quantity": 1,
- "daily_chargable": 1,
- "description": "",
- "params": {
- "image": ""
}, - "state": 1
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "extras",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "charge_type": 0,
- "max_quantity": 0,
- "daily_chargable": 0,
- "reservation_asset_id": 0,
- "state": 0,
- "access": 0,
- "price_includes_tax": 0,
- "description": "string",
- "tax_id": 0,
- "params": {
- "image": "string",
- "article": "string"
}, - "price": 0,
- "price_adult": 0,
- "price_child": 0
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "extras",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "charge_type": 0,
- "max_quantity": 0,
- "daily_chargable": 0,
- "reservation_asset_id": 0,
- "state": 0,
- "access": 0,
- "price_includes_tax": 0,
- "description": "string",
- "tax_id": 0,
- "params": {
- "image": "string",
- "article": "string"
}, - "price": 0,
- "price_adult": 0,
- "price_child": 0
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| name | string Name. |
| reservation_asset_id | integer Id of its property. |
| charge_type | integer How it is charged (see |
| price | number Price. |
| price_adult | number Price per adult. |
| price_child | number Price per child. |
| max_quantity | integer Most a guest can add. |
| daily_chargable | integer 1 to charge it per night. |
| tax_id | integer Id of the tax it is subject to. |
| coupon_id | Array of integers Ids of the coupons that apply to it; an empty list for none. A change that leaves it out keeps them. |
| description | string Description (HTML). |
| params | object Settings; see |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "string",
- "reservation_asset_id": 0,
- "charge_type": 0,
- "price": 0,
- "price_adult": 0,
- "price_child": 0,
- "max_quantity": 0,
- "daily_chargable": 0,
- "tax_id": 0,
- "coupon_id": [
- 0
], - "description": "string",
- "params": { },
- "state": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "extras",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "charge_type": 0,
- "max_quantity": 0,
- "daily_chargable": 0,
- "reservation_asset_id": 0,
- "state": 0,
- "access": 0,
- "price_includes_tax": 0,
- "description": "string",
- "tax_id": 0,
- "params": {
- "image": "string",
- "article": "string"
}, - "price": 0,
- "price_adult": 0,
- "price_child": 0
}, - "relationships": {
- "tax_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}The statuses a reservation (type 0) or a payment (type 1) can be in, with the codes stored on them. An experience booking has statuses of its own, listed here too.
Who reads what. A manager (core.manage on Solidres) reads every row. Anyone else reads the published rows (state 1) and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. Joomla's permissions on Solidres decide: Create (core.create) to add, Edit (core.edit) to change, Delete (core.delete) to delete.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[state] | integer Only rows in this publishing state (reservations: in this status code). |
| filter[type] | integer 0 reservation statuses, 1 payment statuses. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "statuses",
- "id": "string",
- "attributes": {
- "id": 0,
- "label": "string",
- "state": 0,
- "type": 0,
- "code": 0,
- "color_code": "string"
}
}
], - "meta": {
- "total-pages": 0
}
}| label required | string Label. |
| type required | integer 0 a reservation status, 1 a payment status. |
| code required | integer The code stored on a reservation or payment. |
| color_code required | string CSS colour. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "label": "Awaiting deposit",
- "state": 1,
- "code": 10,
- "color_code": "#f89406",
- "type": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "statuses",
- "id": "string",
- "attributes": {
- "id": 0,
- "label": "string",
- "state": 0,
- "type": 0,
- "code": 0,
- "color_code": "string",
- "email_text": "string"
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "statuses",
- "id": "string",
- "attributes": {
- "id": 0,
- "label": "string",
- "state": 0,
- "type": 0,
- "code": 0,
- "color_code": "string",
- "email_text": "string"
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| label | string Label. |
| type | integer 0 a reservation status, 1 a payment status. |
| code | integer The code stored on a reservation or payment. |
| color_code | string CSS colour. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "label": "string",
- "type": 0,
- "code": 0,
- "color_code": "string",
- "state": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "statuses",
- "id": "string",
- "attributes": {
- "id": 0,
- "label": "string",
- "state": 0,
- "type": 0,
- "code": 0,
- "color_code": "string",
- "email_text": "string"
}
}
}Taxes on rooms and extras.
Who reads what. A manager (core.manage on Solidres) reads every row. Anyone else reads the published rows (state 1) and is answered 404 for any other row. Both audiences are shown the same fields.
Who writes. Joomla's permissions on Solidres decide: Create (core.create) to add, Edit (core.edit) to change, Delete (core.delete) to delete.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[state] | integer Only rows in this publishing state (reservations: in this status code). |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "taxes",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "rate": 0,
- "country_id": 0,
- "state": 0,
- "tax_exempt_from": 0
}
}
], - "meta": {
- "total-pages": 0
}
}| name required | string Name. |
| rate required | number Rate as a fraction: 0.1 is 10%. |
| country_id | integer Id of the country it applies in. |
| tax_exempt_from | integer Consecutive days from which a stay is exempt; 0 for no exemption. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "City VAT",
- "rate": 0.08,
- "state": 1,
- "country_id": 224,
- "tax_exempt_from": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "taxes",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "rate": 0,
- "country_id": 0,
- "state": 0,
- "tax_exempt_from": 0
}
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "taxes",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "rate": 0,
- "country_id": 0,
- "state": 0,
- "tax_exempt_from": 0
}
}
}Send only the fields to change.
| id required | integer >= 1 The row id. |
| name | string Name. |
| rate | number Rate as a fraction: 0.1 is 10%. |
| country_id | integer Id of the country it applies in. |
| tax_exempt_from | integer Consecutive days from which a stay is exempt; 0 for no exemption. |
| state | integer Publishing state. |
| property name* additional property | any |
{- "name": "string",
- "rate": 0,
- "country_id": 0,
- "tax_exempt_from": 0,
- "state": 0
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "taxes",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "rate": 0,
- "country_id": 0,
- "state": 0,
- "tax_exempt_from": 0
}
}
}Payments recorded against reservations (scope 0) and experience bookings (scope 1). Read only. What a gateway reported (payment_data) is never shown, to anyone.
Who reads what. A manager (a user allowed Access Administration Interface, core.manage, on Solidres) reads every row. Anyone else reads the rows of the properties they are the partner or a staff member of on a Hub site, in any state, and is answered 404 for any other row. Both audiences are shown the same fields.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[payment_date] | string Only payments made on this date. |
| filter[payment_status] | integer Only rows in this payment status. |
| filter[payment_method_id] | string Only payments by this method (its plugin element). |
| filter[reservation_id] | integer Only payments of this booking. |
| filter[scope] | integer 0 (default) reservations' payments, 1 experience bookings' payments. |
| filter[payment_type] | string Only payments of this kind. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "paymenthistory",
- "id": "string",
- "attributes": {
- "id": 0,
- "reservation_id": 0,
- "scope": 0,
- "payment_date": "2026-10-17 08:30:00",
- "payment_status": 0,
- "currency_id": 0,
- "payment_method_id": "string",
- "payment_method_txn_id": "string",
- "payment_method_surcharge": "120.000000",
- "payment_method_discount": "120.000000",
- "payment_amount": "120.000000",
- "title": "string",
- "description": "string",
- "payment_type": 0,
- "reservation_code": "string",
- "currency_code": "string",
- "reservation_asset_id": 0,
- "experience_id": 0
}, - "relationships": {
- "reservation_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "experience_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "currency_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
], - "meta": {
- "total-pages": 0
}
}Reservations: bookings of rooms. Read only. What a gateway or the card form left on a booking (payment_data) and the guest's feedback key (token) are never shown, to anyone.
Who reads what. A manager (a user allowed Access Administration Interface, core.manage, on Solidres) reads every row. Anyone else reads the rows of the properties they are the partner or a staff member of on a Hub site, in any state, and is answered 404 for any other row. Both audiences are shown the same fields.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer >= 1 Rows per page. The default is the site's list length (Global Configuration), usually 20. |
| list[ordering] | string The column to sort by, as the administrator's list sorts. |
| list[direction] | string Enum: "ASC" "DESC" "asc" "desc" Sort direction. |
| filter[search] | string Text to look for, matched as the administrator list's search box matches it. |
| filter[state] | integer Only rows in this publishing state (reservations: in this status code). |
| filter[payment_status] | integer Only rows in this payment status. |
| filter[payment_method_txn_id] | string Only the booking with this gateway transaction id. |
| filter[checkin_from] | string Only stays checking in on or after this date ( |
| filter[checkin_to] | string Only stays checking in on or before this date. |
| filter[checkout_from] | string Only stays checking out on or after this date. |
| filter[checkout_to] | string Only stays checking out on or before this date. |
| filter[reservation_asset_id] | integer Only rows of this property. |
| filter[location] | string Only bookings of properties in this city. |
| filter[customer_fullname] | string Only bookings made by a customer of this name. |
| filter[guest_fullname] | string Only bookings with a guest of this name. |
| filter[origin] | integer Only bookings from this origin. |
| filter[coupon_code] | string Only bookings that used this coupon code. |
| filter[customer] | string Only bookings of this customer. |
| filter[reserved_rooms] | string Only bookings of these rooms. |
| filter[clear] | integer Set to 1 to reset the filters the administrator's list remembers. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "reservations",
- "id": "string",
- "attributes": {
- "id": 0,
- "state": 0,
- "customer_id": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_date": "2026-10-17 08:30:00",
- "modified_by": 0,
- "created_by": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "payment_method_id": "string",
- "payment_method_txn_id": "string",
- "payment_method_surcharge": "120.000000",
- "payment_method_discount": "120.000000",
- "payment_status": 0,
- "code": "string",
- "coupon_id": 0,
- "coupon_code": "string",
- "customer_title": "string",
- "customer_firstname": "string",
- "customer_middlename": "string",
- "customer_lastname": "string",
- "customer_email": "string",
- "customer_phonenumber": "string",
- "customer_mobilephone": "string",
- "customer_company": "string",
- "customer_address1": "string",
- "customer_address2": "string",
- "customer_city": "string",
- "customer_zipcode": "string",
- "customer_country_id": 0,
- "customer_geo_state_id": 0,
- "customer_vat_number": "string",
- "customer_ip": "string",
- "customer_coordinates": "string",
- "customer_language": "string",
- "customer_ua": "string",
- "customer_ismobile": 0,
- "checkin": "2026-10-17",
- "checkout": "2026-10-17",
- "currency_id": 0,
- "currency_code": "string",
- "total_price": "120.000000",
- "total_price_tax_incl": "120.000000",
- "total_price_tax_excl": "120.000000",
- "total_extra_price": "120.000000",
- "total_extra_price_tax_incl": "120.000000",
- "total_extra_price_tax_excl": "120.000000",
- "total_experience_price_tax_incl": "120.000000",
- "total_experience_price_tax_excl": "120.000000",
- "total_discount": "120.000000",
- "note": "string",
- "reservation_asset_id": 0,
- "reservation_asset_name": "string",
- "deposit_amount": "120.000000",
- "total_paid": "120.000000",
- "discount_pre_tax": 0,
- "tax_amount": "120.000000",
- "tourist_tax_amount": "120.000000",
- "tourist_tax_at_property": "120.000000",
- "tourist_tax": [
- {
- "tourist_tax_id": 0,
- "name": "string",
- "unit": 1,
- "unit_key": "person_night",
- "method": 1,
- "method_key": "flat",
- "collect_at_property": true,
- "amount": 0,
- "vat_rate": 0,
- "vat_amount": 0,
- "total": 0,
- "charges": [
- {
- "reservation_room_id": 0,
- "night": "string",
- "rate_applied": 0,
- "persons_full": 0,
- "persons_reduced": 0,
- "persons_exempt": 0,
- "taxable_base": 0,
- "amount": 0,
- "vat_amount": 0,
- "status": 0,
- "status_key": "taxed",
- "note": "string"
}
]
}
], - "booking_type": 0,
- "total_single_supplement": "120.000000",
- "total_fee": "120.000000",
- "origin": "string",
- "origin_id": 0,
- "accessed_date": "2026-10-17 08:30:00",
- "target": 0,
- "cm_provider": 0,
- "cm_id": "string",
- "cm_creation_date": "2026-10-17 08:30:00",
- "cm_modification_date": "2026-10-17 08:30:00",
- "cm_channel_order_id": "string",
- "cm_payment_collect": 0,
- "is_approved": 0,
- "checkinout_status": 0,
- "checked_in_date": "2026-10-17 08:30:00",
- "checked_out_date": "2026-10-17 08:30:00",
- "reservation_meta": { },
- "confirmation_date": "2026-10-17 08:30:00",
- "customer_fullname": "string",
- "total_amount": "120.000000",
- "length_of_stay": 0,
- "customer_country_name": "string"
}, - "relationships": {
- "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "coupon_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "currency_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "origin_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
], - "meta": {
- "total-pages": 0
}
}| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "reservations",
- "id": "string",
- "attributes": {
- "id": 0,
- "state": 0,
- "customer_id": 0,
- "created_date": "2026-10-17 08:30:00",
- "modified_date": "2026-10-17 08:30:00",
- "modified_by": 0,
- "created_by": 0,
- "checked_out": 0,
- "checked_out_time": "2026-10-17 08:30:00",
- "payment_method_id": "string",
- "payment_method_txn_id": "string",
- "payment_method_surcharge": "120.000000",
- "payment_method_discount": "120.000000",
- "payment_status": 0,
- "code": "string",
- "coupon_id": 0,
- "coupon_code": "string",
- "customer_title": "string",
- "customer_firstname": "string",
- "customer_middlename": "string",
- "customer_lastname": "string",
- "customer_email": "string",
- "customer_phonenumber": "string",
- "customer_mobilephone": "string",
- "customer_company": "string",
- "customer_address1": "string",
- "customer_address2": "string",
- "customer_city": "string",
- "customer_zipcode": "string",
- "customer_country_id": 0,
- "customer_geo_state_id": 0,
- "customer_vat_number": "string",
- "customer_ip": "string",
- "customer_coordinates": "string",
- "customer_language": "string",
- "customer_ua": "string",
- "customer_ismobile": 0,
- "checkin": "2026-10-17",
- "checkout": "2026-10-17",
- "currency_id": 0,
- "currency_code": "string",
- "total_price": "120.000000",
- "total_price_tax_incl": "120.000000",
- "total_price_tax_excl": "120.000000",
- "total_extra_price": "120.000000",
- "total_extra_price_tax_incl": "120.000000",
- "total_extra_price_tax_excl": "120.000000",
- "total_experience_price_tax_incl": "120.000000",
- "total_experience_price_tax_excl": "120.000000",
- "total_discount": "120.000000",
- "note": "string",
- "reservation_asset_id": 0,
- "reservation_asset_name": "string",
- "deposit_amount": "120.000000",
- "total_paid": "120.000000",
- "discount_pre_tax": 0,
- "tax_amount": "120.000000",
- "tourist_tax_amount": "120.000000",
- "tourist_tax_at_property": "120.000000",
- "tourist_tax": [
- {
- "tourist_tax_id": 0,
- "name": "string",
- "unit": 1,
- "unit_key": "person_night",
- "method": 1,
- "method_key": "flat",
- "collect_at_property": true,
- "amount": 0,
- "vat_rate": 0,
- "vat_amount": 0,
- "total": 0,
- "charges": [
- {
- "reservation_room_id": 0,
- "night": "string",
- "rate_applied": 0,
- "persons_full": 0,
- "persons_reduced": 0,
- "persons_exempt": 0,
- "taxable_base": 0,
- "amount": 0,
- "vat_amount": 0,
- "status": 0,
- "status_key": "taxed",
- "note": "string"
}
]
}
], - "booking_type": 0,
- "total_single_supplement": "120.000000",
- "total_fee": "120.000000",
- "origin": "string",
- "origin_id": 0,
- "accessed_date": "2026-10-17 08:30:00",
- "target": 0,
- "cm_provider": 0,
- "cm_id": "string",
- "cm_creation_date": "2026-10-17 08:30:00",
- "cm_modification_date": "2026-10-17 08:30:00",
- "cm_channel_order_id": "string",
- "cm_payment_collect": 0,
- "is_approved": 0,
- "checkinout_status": 0,
- "checked_in_date": "2026-10-17 08:30:00",
- "checked_out_date": "2026-10-17 08:30:00",
- "reservation_meta": { },
- "confirmation_date": "2026-10-17 08:30:00",
- "customer_fullname": "string",
- "total_amount": "120.000000",
- "length_of_stay": 0,
- "customer_country_name": "string"
}, - "relationships": {
- "property": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "created_by": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "coupon_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "currency_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}, - "origin_id": {
- "data": {
- "type": "string",
- "id": "string"
}
}
}
}
}What a guest of the site sees before booking, for anyone, without a token: the published properties, their room types with a starting price, the extras they sell, the tours they sell with a stay, and what they can sell for a stay.
Who reads what. Anyone reads the properties that are published and of an access level a guest has, and their published room types, as the property pages show them. Any other property answers 404, as one that does not exist. The fields are the ones a property page shows a guest; nothing about who runs a property, its settings, or where its notifications go.
Rate limits. Requests are counted per client address (every route) and per property (availability checks, from every address together). A request over a limit answers 429 with Retry-After, the seconds to wait; Public booking has the limits.
Off by default. These routes answer 404 until Public booking API is switched on in Solidres Options.
The published properties of an access level a guest has, as the site lists them, in their manual ordering.
| page[offset] | integer >= 0 Default: 0 The first row of the page, counted from 0. |
| page[limit] | integer [ 1 .. 100 ] Rows per page, at most 100. The default is the site's list length (Global Configuration), usually 20. |
{- "links": {
- "self": "string",
- "first": "string",
- "previous": "string",
- "next": "string",
- "last": "string"
}, - "data": [
- {
- "type": "reservationassets",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "alternative_name": "string",
- "alias": "string",
- "description": "string",
- "category_name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "postcode": "string",
- "geostate_name": "string",
- "country_name": "string",
- "country_code": "string",
- "lat": "120.000000",
- "lng": "120.000000",
- "phone": "string",
- "website": "string",
- "rating": 0,
- "currency_code": "string",
- "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "url": "string"
}
}
], - "meta": {
- "total-pages": 0
}
}One property, with the facilities and policies its page lists. A property guests are not shown answers 404, as one that does not exist.
| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "reservationassets",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "alternative_name": "string",
- "alias": "string",
- "description": "string",
- "category_name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "postcode": "string",
- "geostate_name": "string",
- "country_name": "string",
- "country_code": "string",
- "lat": "120.000000",
- "lng": "120.000000",
- "phone": "string",
- "website": "string",
- "rating": 0,
- "currency_code": "string",
- "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "url": "string",
- "facilities": {
- "general": "string",
- "activities": "string",
- "services": "string",
- "internet": "string",
- "parking": "string"
}, - "policies": {
- "checkin_time": "string",
- "checkout_time": "string",
- "cancellation_prepayment": "string",
- "children_and_extra_beds": "string",
- "pets": "string",
- "accepted_credit_cards": "string"
}
}
}
}The room types the property's page shows, all on one page, each with its starting price: the lowest of its rate plans, as the page shows it before a guest picks dates.
| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": [
- {
- "type": "roomtypes",
- "id": "string",
- "attributes": {
- "id": 0,
- "reservation_asset_id": 0,
- "name": "string",
- "alias": "string",
- "description": "string",
- "occupancy_max": 0,
- "occupancy_adult": 0,
- "occupancy_child": 0,
- "occupancy_child_age_range": 0,
- "smoking": 0,
- "is_private": 0,
- "media": [
- {
- "image": "string",
- "thumb": "string"
}
], - "amenities": {
- "room_facilities": "string",
- "room_size": "string",
- "bed_size": "string"
}, - "base_price": {
- "tariff_id": 0,
- "title": "string",
- "price_tax_excl": 0,
- "price_tax_incl": 0,
- "per": "room",
- "unit": "night",
- "units": 1,
- "persons": 1
}
}
}
]
}What the property can sell for a stay: per room type, the rooms still free and each rate plan that applies, with its price for the whole stay, as the property page shows them for the same search.
Every room of the search has the same guests. To price rooms for different guests, ask for a quote.
| id required | integer >= 1 The row id. |
| checkin required | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Examples: checkin=2026-10-17 Arrival date, |
| checkout required | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Examples: checkout=2026-10-17 Departure date, |
| rooms | integer [ 1 .. 20 ] Default: 1 How many rooms. |
| adults | integer [ 1 .. 50 ] Default: 1 Adults in each room. |
| children_ages | string^[0-9]{1,2}(,[0-9]{1,2})*$ The age of each child in each room, in years at check-out, comma separated ( |
| children | integer >= 0 How many children in each room; when sent, it must count |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "availability",
- "id": "string",
- "attributes": {
- "property_id": 0,
- "checkin": "2026-10-17",
- "checkout": "2026-10-17",
- "booking_type": "night",
- "length": 0,
- "currency": "string",
- "room_types": [
- {
- "room_type_id": 0,
- "name": "string",
- "available": 0,
- "bookable": true,
- "closed": [
- "sold_out"
], - "occupancy": {
- "adults": 0,
- "children": 0,
- "max": 0
}, - "lowest_price": {
- "tariff_id": 0,
- "price_tax_excl": 0,
- "price_tax_incl": 0
}, - "min_stay": 0,
- "max_stay": 0,
- "rates": [
- {
- "tariff_id": 0,
- "title": "string",
- "description": "string",
- "type": 0,
- "price_tax_excl": 0,
- "price_tax_incl": 0,
- "price_tax_excl_original": 0,
- "price_tax_incl_original": 0,
- "min_stay": 0,
- "max_stay": 0,
- "min_rooms": 0,
- "max_rooms": 0
}
]
}
]
}
}
}The extras a guest may add to a booking at the property, as the booking form offers them, all on one page, each with its price and where a quote takes it: in a room's extras when the room's type is in room_type_ids, in the quote's own extras when booking is true. A mandatory extra is added to every quote whether it is asked for or not.
What an extra costs follows its charge: once (per_room, per_booking), each night (…_per_night; each day where the property books by the day), for each guest at the adult and child prices (…_per_person), or as a share of the room's price before tax (percent_of_room_rate). The quote works out the amount.
Without dates, every extra the property sells. With checkin and checkout, the extras on sale for that stay: an extra the property sells on some dates only is left out when the stay is not within them.
| id required | integer >= 1 The row id. |
| checkin | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Examples: checkin=2026-10-17 Arrival date, |
| checkout | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Examples: checkout=2026-10-17 Departure date, |
{- "links": {
- "self": "string"
}, - "data": [
- {
- "type": "extras",
- "id": "string",
- "attributes": {
- "id": 0,
- "reservation_asset_id": 0,
- "name": "string",
- "description": "string",
- "image": "string",
- "charge": "per_room",
- "mandatory": true,
- "max_quantity": 1,
- "price_tax_excl": 0,
- "price_tax_incl": 0,
- "price_adult_tax_excl": 0,
- "price_adult_tax_incl": 0,
- "price_child_tax_excl": 0,
- "price_child_tax_incl": 0,
- "percent": 0,
- "room_type_ids": [
- 0
], - "booking": true
}
}
]
}The tours (experiences) a guest may add to a stay at the property, as the booking form offers them, all on one page: the published tours linked to the property, each with the dates it departs on, its time slots, the age ranges its children are priced by, and its extras. A quote's experiences books them with the rooms.
Without dates, every date a tour can be booked on. With checkin and checkout, the dates inside that stay, check-in and check-out days included, unless the property lets a tour depart outside the stay; a tour with no date left is left out. Seats are checked by the quote: a date listed here can still be full for the participants asked for.
Only on a site with the Experience add-on, which adds this route; elsewhere it answers 404.
| id required | integer >= 1 The row id. |
| checkin | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Examples: checkin=2026-10-17 Arrival date, |
| checkout | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Examples: checkout=2026-10-17 Departure date, |
{- "links": {
- "self": "string"
}, - "data": [
- {
- "type": "experiences",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "description": "string",
- "link": "string",
- "image": "string",
- "currency": "string",
- "price_from_tax_excl": 0,
- "price_from_tax_incl": 0,
- "start_time": "string",
- "duration": 0,
- "duration_unit": "hours",
- "min_participants": 1,
- "max_participants": 0,
- "children_take_seats": true,
- "children": [
- {
- "age_range": "string",
- "age_from": 0,
- "age_to": 0
}
], - "extras": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "mandatory": true,
- "max_quantity": 0,
- "price_tax_excl": 0,
- "price_tax_incl": 0
}
], - "time_slots": [
- {
- "id": 0,
- "guide_name": "string",
- "from": "string",
- "to": "string",
- "weekday": 1
}
], - "dates": [
- "2026-10-17"
]
}
}
]
}Book without the site's form, for anyone, without a token: ask for a quote, book it, and let the guest look the booking up.
A quote prices the booking exactly as the booking form does, and seals it in its id for 30 minutes; the reservation route books from that id alone, so a caller never sends a price. Errors on these routes say which field is at fault (see PublicErrors).
Every request below goes without a token. $API stands for your site's public routes; the answers are a real run, shortened where a list repeats itself (…).
API=https://www.example.com/api/index.php/v1/solidres/public
1. What the site lets. The properties guests are shown, then a property's room types, each with the starting price its page shows.
curl -s "$API/properties?page[limit]=20" -H 'Accept: application/vnd.api+json'
curl -s "$API/properties/900003/room-types" -H 'Accept: application/vnd.api+json'
{
"data": [
{
"type": "roomtypes",
"id": "900010",
"attributes": {
"name": "Classic Double",
"occupancy_max": 2, "occupancy_adult": 2, "occupancy_child": 0,
"amenities": {"room_size": "18 m2", "bed_size": "Double 140x200", "room_facilities": "Shower room, desk, safe, kettle, 40 inch TV, blackout blinds"},
"base_price": {"tariff_id": 900030, "title": "Non-refundable", "price_tax_excl": 142.18, "price_tax_incl": 170.61, "per": "room", "unit": "night", "units": 1, "persons": null},
…
}
},
…
]
}
2. What is free. Per room type: the rooms free for the whole stay and each rate plan that applies, priced for the stay.
curl -s "$API/properties/900003/availability?checkin=2027-03-18&checkout=2027-03-20&adults=2" \
-H 'Accept: application/vnd.api+json'
{
"data": {
"type": "availability",
"id": "900003:2027-03-18:2027-03-20",
"attributes": {
"property_id": 900003, "checkin": "2027-03-18", "checkout": "2027-03-20",
"booking_type": "night", "length": 2, "currency": "GBP",
"room_types": [
{
"room_type_id": 900010, "name": "Classic Double", "available": 8, "bookable": true, "closed": [],
"occupancy": {"adults": 2, "children": 0, "max": 2},
"lowest_price": {"tariff_id": 900030, "price_tax_excl": 254.1, "price_tax_incl": 304.92},
"min_stay": 1, "max_stay": 30,
"rates": [
{"tariff_id": 900029, "title": "Flexible rate", "description": "Free cancellation, pay on arrival.", "type": 0,
"price_tax_excl": 314.82, "price_tax_incl": 377.78, "min_stay": 1, "max_stay": 21, …},
{"tariff_id": 900030, "title": "Non-refundable", "price_tax_excl": 254.1, "price_tax_incl": 304.92, "min_stay": 2, …}
]
},
…
]
}
}
}
3. What can be added. The extras the property sells, each with its price and where a quote takes it: in a room's extras when the room's type is in room_type_ids, in the quote's own extras when booking is true. With the stay's dates, only those on sale for it. charge says how it is charged (once, each night, for each guest, or a share of the room's price); the quote works out the amount.
curl -s "$API/properties/900003/extras?checkin=2027-03-18&checkout=2027-03-20" -H 'Accept: application/vnd.api+json'
{
"data": [
{
"type": "extras",
"id": "900008",
"attributes": {
"id": 900008, "reservation_asset_id": 900003, "name": "Theatre ticket booking",
"description": "We hold and collect West End tickets for your arrival.", "image": null,
"charge": "per_room", "mandatory": false, "max_quantity": 1,
"price_tax_excl": 15, "price_tax_incl": 18,
"price_adult_tax_excl": null, "price_adult_tax_incl": null, "price_child_tax_excl": null, "price_child_tax_incl": null,
"percent": null, "room_type_ids": [900010, 900011], "booking": false
}
}
]
}
An extra charged for each guest has adult and child prices instead, and null flat ones; a breakfast elsewhere reads "charge": "per_room_per_person_per_night", "price_adult_tax_incl": 29.96, "price_child_tax_incl": 14.98. A mandatory extra is added to every quote whether it is asked for or not.
Where the site sells tours with a stay (the Experience add-on), GET $API/properties/900003/experiences?checkin=2027-03-18&checkout=2027-03-20 lists the tours the stay can take, each with the dates it departs on, its time slots, children's age ranges and extras; a quote's experiences books them with the rooms.
4. The quote. Name each room's room type, rate plan (tariff_id) and guests, the extras and a coupon code. The answer is the whole price, night by night, and what each payment method makes of it. Keep its id: it is the quote, sealed, and it holds for 30 minutes (expires_at).
curl -s -X POST "$API/quotes" -H 'Accept: application/vnd.api+json' -H 'Content-Type: application/json' \
-d '{"property_id": 900003, "checkin": "2027-03-18", "checkout": "2027-03-20",
"rooms": [{"room_type_id": 900010, "tariff_id": 900029, "adults": 2}]}'
{
"data": {
"type": "quotes",
"id": "eyJ2IjoxLCJleHAiOjE3OTIzOTE0MjEsInF1b3RlIjp7…FdjulV3Zu1QkodrP-p_MK0dqpQ3uAf0Hu3LfOnHARBA",
"attributes": {
"expires_at": "2026-10-19T06:30:21Z",
"property_id": 900003, "checkin": "2027-03-18", "checkout": "2027-03-20",
"booking_type": "night", "length": 2, "currency": "GBP",
"rooms": [
{
"room_type_id": 900010, "room_type_name": "Classic Double", "tariff_id": 900029, "tariff_title": "Flexible rate",
"adults": 2, "children_ages": [], "guest_name": "",
"price_tax_excl": 314.82, "price_tax_incl": 377.78, "discount": 0,
"price_tax_excl_discounted": 314.82, "price_tax_incl_discounted": 377.78,
"single_supplement": 0, "coupon_applied": false,
"nights": [
{"date": "2027-03-18", "price_tax_excl": 142.83, "price_tax_incl": 171.4},
{"date": "2027-03-19", "price_tax_excl": 171.98, "price_tax_incl": 206.38}
],
"extras": [], "tourist_tax": 0
}
],
"extras": [],
"experiences": [],
"coupon": null,
"totals": {
"rooms_tax_excl": 314.82, "rooms_tax_incl": 377.78, "discount": 0, "rooms_tax_excl_discounted": 314.82,
"tax": 62.96, "single_supplement": 0, "extras_tax_excl": 0, "extras_tax_incl": 0,
"experiences_tax_excl": 0, "experiences_tax_incl": 0,
"tourist_tax": 0, "tourist_tax_at_property": 0, "fee": 0, "total": 377.78
},
"tourist_tax": [],
"deposit_required": false,
"payment_methods": [
{"id": "bankwire", "title": "Bank Wire", "default": false, "available_via_api": true, "pays_online": false,
"surcharge": 0, "discount": 0, "total": 377.78, "deposit": null, "due_now": 377.78, "due_later": 0},
{"id": "paylater", "title": "Pay Later", "default": true, "available_via_api": true, "pays_online": false,
"surcharge": 0, "discount": 0, "total": 377.78, "deposit": null, "due_now": 377.78, "due_later": 0}
]
}
}
}
5. The booking. Send the quote's id unchanged, a payment method of the quote's and the guest. Nothing about the price is sent: the site prices the quote again and books it only at the quoted total.
The guest's country_id is one of the countries the booking form offers, and geo_state_id, where the guest form asks for one, one of that country's states. Both lists change only with the site's settings; keep them for the hour Cache-Control allows.
curl -s "$API/countries" -H 'Accept: application/vnd.api+json'
curl -s "$API/countries/172/states" -H 'Accept: application/vnd.api+json'
{"data": [{"type": "countries", "id": "2", "attributes": {"id": 2, "name": "Afghanistan", "code_2": "AF", "code_3": "AFG", "default": false, "has_states": true}}, …]}
{"data": [{"type": "states", "id": "2945", "attributes": {"id": 2945, "country_id": 172, "name": "Aveiro", "code_2": "", "code_3": ""}}, …]}
curl -s -X POST "$API/reservations" -H 'Accept: application/vnd.api+json' -H 'Content-Type: application/json' \
-d '{"quote_id": "eyJ2IjoxLCJleHAiOjE3OTIzOTE0MjEsInF1b3RlIjp7…HARBA", "payment_method": "paylater",
"guest": {"firstname": "Ana", "lastname": "Silva", "email": "ana@example.com", "phonenumber": "+351 21 000 0000",
"address1": "Rua Augusta 1", "city": "Lisboa", "country_id": 172}}'
{
"data": {
"type": "reservations",
"id": "d6409c78",
"attributes": {
"code": "d6409c78", "state": 0, "payment_status": 0, "approved": true, "payment_method": "paylater",
"total": 377.78, "due_now": 377.78, "currency": "GBP",
"payment_url": null, "confirmed": true, "email_sent": true
}
}
}
The answer is 201. The booking is in the back office at that price, and the site did what it does for a booking made on its form: the property's confirmation rules, the e-mails to the guest and the property, the coupon's use counted, and every Solidres plugin's part (an invoice, when the Invoice plugin is on).
Paying online. With a method whose pays_online is true, the booking waits for its payment: confirmed is false, and payment_url is the site's own page that takes it. Send the guest's browser there; it hands them to the gateway for what is due now. Card numbers never go through the API, and methods that take a card on the site's booking form are offered with available_via_api: false.
The price moved. When the price for the payment method is no longer the quoted one (a rate or an extra changed), nothing is booked: the answer is 409 quote_changed, and errors[0].meta.quote is the quote that stands now. Show its price, and book with its id. A quote id that has expired answers 422 quote_expired; one this site did not issue, or that was changed, 422 quote_invalid. The same booking sent twice answers 409 duplicate.
6. The guest's look. The booking's code and the e-mail address it was made with, both needed. A wrong address and an unknown code answer the same 404.
curl -s "$API/reservations/d6409c78?email=ana@example.com" -H 'Accept: application/vnd.api+json'
{
"data": {
"type": "reservations",
"id": "d6409c78",
"attributes": {
"code": "d6409c78", "property_id": 900003, "property_name": "Chestnut Boutique Hotel",
"checkin": "2027-03-18", "checkout": "2027-03-20", "booking_type": "night", "length": 2,
"state": 0, "state_label": "Pending", "payment_status": 0, "payment_status_label": "Unpaid",
"approved": true, "payment_method": "paylater", "currency": "GBP",
"total": 377.78, "deposit": null, "paid": 0, "balance": 377.78, "tourist_tax_at_property": 0,
"guest": {"title": "", "firstname": "Ana", "lastname": "Silva"},
"rooms": [{"room_type_id": 900010, "room_type_name": "Classic Double", "tariff_title": "Flexible rate", "adults": 2, "children": 0, "guest_name": ""}],
"created_date": "2026-10-19 06:00:21",
"payment_url": null
}
}
}
Every request to a public route is counted before it is served. One over a limit answers 429 and is not served; nothing is counted for it.
| Limit (Solidres Options, Integrations) | Default | Counts |
|---|---|---|
| Requests per address | 60 a minute | Every public request from one client address |
| Searches and bookings per property | 300 a minute | Availability checks, quotes and bookings for one property, from every address together |
| Bookings per address | 10 an hour | POST …/reservations from one address, booked or refused |
| Booking look-ups per address | 5 an hour | GET …/reservations/{code} from one address, found or not |
A limit of 0 is off. A client gets the whole limit at once, then one request more each period ÷ limit (at 60 a minute, one a second). The 429 says how long to wait in Retry-After and meta.retry_after (seconds) and which limit in meta.limit:
{"errors": [{"status": "429", "code": "throttled", "title": "Too many requests: try again once the seconds in Retry-After have passed.",
"meta": {"limit": "address", "retry_after": 12}}]}
Behind a proxy or a CDN, every request arrives from the proxy's address unless Global Configuration → Server → Behind Load Balancer is on. With it on, Joomla takes the client from the first X-Forwarded-For entry, so the proxy must replace that header with the address it saw, not add to it.
A page on another domain that calls these routes from the browser, such as a booking widget, needs Joomla's CORS: Global Configuration → Server → Enable CORS, with CORS Allow Origin set to that page's origin (or *) and CORS Allow Headers still allowing Content-Type, as Joomla's default does (a JSON body makes the browser ask first). Joomla then answers the browser's preflight. On a 429 the site also sends Access-Control-Expose-Headers: Retry-After, so the page can read how long to wait.
Off by default. These routes answer 404 until Public booking API is switched on in Solidres Options (Integrations).
Prices a booking as the site's booking form prices it: each room night by night, the extras, discounts and coupon, the tax, the tourist tax, the booking fee, and what each payment method the property offers makes of the total and the deposit. Amounts are in the property's currency.
The quote is sealed in its id, which holds for 30 minutes. Book it with POST /v1/solidres/public/reservations. Nothing is stored and no room is held.
| property_id required | integer >= 1 |
| checkin required | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ |
| checkout required | string (SqlDate) ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ |
required | Array of objects [ 1 .. 20 ] items |
Array of objects (RequestedExtra) Extras for the whole booking: those | |
Array of objects (RequestedExperience) <= 10 items Tours booked with the stay, where the site sells them ( | |
| coupon_code | string <= 255 characters |
| currency | string Optional: the ISO 4217 code expected. A quote is always in the property's currency; any other is refused. |
{- "property_id": 1,
- "checkin": "2026-11-20",
- "checkout": "2026-11-23",
- "rooms": [
- {
- "room_type_id": 3,
- "tariff_id": 7,
- "adults": 2,
- "children_ages": [
- 6
], - "extras": [
- {
- "extra_id": 2,
- "quantity": 1
}
]
}
], - "extras": [ ],
- "coupon_code": ""
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "quotes",
- "id": "string",
- "attributes": {
- "expires_at": "string",
- "property_id": 0,
- "checkin": "2026-10-17",
- "checkout": "2026-10-17",
- "booking_type": "night",
- "length": 0,
- "currency": "string",
- "rooms": [
- {
- "room_type_id": 0,
- "room_type_name": "string",
- "tariff_id": 0,
- "tariff_title": "string",
- "adults": 0,
- "children_ages": [
- 0
], - "guest_name": "string",
- "price_tax_excl": 0,
- "price_tax_incl": 0,
- "discount": 0,
- "price_tax_excl_discounted": 0,
- "price_tax_incl_discounted": 0,
- "single_supplement": 0,
- "coupon_applied": true,
- "nights": [
- {
- "date": "2026-10-17",
- "price_tax_excl": 0,
- "price_tax_incl": 0
}
], - "extras": [
- {
- "extra_id": 0,
- "name": "string",
- "quantity": 0,
- "price_tax_excl": 0,
- "price_tax_incl": 0
}
], - "tourist_tax": 0
}
], - "extras": [
- {
- "extra_id": 0,
- "name": "string",
- "quantity": 0,
- "price_tax_excl": 0,
- "price_tax_incl": 0
}
], - "experiences": [
- {
- "experience_id": 0,
- "name": "string",
- "date": "2026-10-17",
- "time": "string",
- "time_slot_id": 0,
- "adults": 0,
- "children": [
- {
- "age_range": "string",
- "quantity": 0
}
], - "participants": 0,
- "extras": [
- {
- "extra_id": 0,
- "name": "string",
- "quantity": 0
}
], - "price_tax_excl": 0,
- "price_tax_incl": 0
}
], - "coupon": {
- "code": "string",
- "name": "string",
- "applied": true
}, - "totals": {
- "rooms_tax_excl": 0,
- "rooms_tax_incl": 0,
- "discount": 0,
- "rooms_tax_excl_discounted": 0,
- "tax": 0,
- "single_supplement": 0,
- "extras_tax_excl": 0,
- "extras_tax_incl": 0,
- "experiences_tax_excl": 0,
- "experiences_tax_incl": 0,
- "tourist_tax": 0,
- "tourist_tax_at_property": 0,
- "fee": 0,
- "total": 0
}, - "tourist_tax": [
- {
- "room": 0,
- "tourist_tax_id": 0,
- "name": "string",
- "night": "string",
- "persons_full": 0,
- "persons_reduced": 0,
- "persons_exempt": 0,
- "amount": 0,
- "vat_amount": 0,
- "collect_at_property": true
}
], - "deposit_required": true,
- "payment_methods": [
- {
- "id": "string",
- "title": "string",
- "default": true,
- "available_via_api": true,
- "pays_online": true,
- "surcharge": 0,
- "discount": 0,
- "total": 0,
- "deposit": 0,
- "due_now": 0,
- "due_later": 0
}
]
}
}
}Books the quote for a guest, as the site's booking form books: the same checks, the same events, the same e-mails. The quote is priced again first; when the price for the payment method is no longer the quoted one, nothing is booked and the answer is 409 with the quote that stands now in meta.quote.
With a payment method paid offline (pay later, bank wire) the booking is confirmed by the property's rules in the same request. With one paid online, the booking waits for its payment and payment_url is the site page that takes it; send the guest there. Card numbers are never taken through the API.
| quote_id required | string The id of a quote from |
| payment_method required | string One of the quote's payment methods with |
required | object (ReservationGuest) The guest, as the booking form asks for them. Which fields are required follows the property's guest form (by default: firstname, lastname, email, phonenumber, address1, city, country_id). No password and no card number are taken. |
{- "quote_id": "eyJ2IjoxLCJleHAiOjE3OTU…",
- "payment_method": "paylater",
- "guest": {
- "firstname": "Ana",
- "lastname": "Silva",
- "email": "ana@example.com",
- "phonenumber": "+351 21 000 0000",
- "address1": "Rua Augusta 1",
- "city": "Lisboa",
- "country_id": 172
}
}{- "links": {
- "self": "string"
}, - "data": {
- "type": "reservations",
- "id": "string",
- "attributes": {
- "code": "string",
- "state": 0,
- "payment_status": 0,
- "approved": true,
- "payment_method": "string",
- "total": 0,
- "due_now": 0,
- "currency": "string",
- "payment_url": "string",
- "confirmed": true,
- "email_sent": true
}
}
}A guest's own booking, given the e-mail address it was made with. A code that does not exist and an address that does not match both answer 404. While the booking can still be paid online, payment_url is the page to pay it on.
| code required | string <= 32 characters The reservation code. |
| email required | string The e-mail address the booking was made with; letter case does not matter. |
{- "links": {
- "self": "string"
}, - "data": {
- "type": "reservations",
- "id": "string",
- "attributes": {
- "code": "string",
- "property_id": 0,
- "property_name": "string",
- "checkin": "2026-10-17",
- "checkout": "2026-10-17",
- "booking_type": "night",
- "length": 0,
- "state": 0,
- "state_label": "string",
- "payment_status": 0,
- "payment_status_label": "string",
- "approved": true,
- "payment_method": "string",
- "currency": "string",
- "total": 0,
- "experiences_tax_incl": 0,
- "deposit": 0,
- "paid": 0,
- "balance": 0,
- "tourist_tax_at_property": 0,
- "guest": {
- "title": "string",
- "firstname": "string",
- "lastname": "string"
}, - "rooms": [
- {
- "room_type_id": 0,
- "room_type_name": "string",
- "tariff_title": "string",
- "adults": 0,
- "children": 0,
- "guest_name": "string"
}
], - "created_date": "2026-10-17 08:30:00",
- "payment_url": "string"
}
}
}The countries the booking form offers, all on one page, by name: a reservation's guest.country_id is one of them. default marks the one the form starts with; has_states says whether the country has states to pick from. The list changes only when the site's settings do: it may be kept for an hour (Cache-Control).
{- "links": {
- "self": "string"
}, - "data": [
- {
- "type": "countries",
- "id": "string",
- "attributes": {
- "id": 0,
- "name": "string",
- "code_2": "string",
- "code_3": "string",
- "default": true,
- "has_states": true
}
}
]
}The states of a country the booking form offers, all on one page, by name: a reservation's guest.geo_state_id is one of them, and must be one of its guest.country_id. A country the form does not offer answers 404. Kept for an hour, as the countries.
| id required | integer >= 1 The row id. |
{- "links": {
- "self": "string"
}, - "data": [
- {
- "type": "states",
- "id": "string",
- "attributes": {
- "id": 0,
- "country_id": 0,
- "name": "string",
- "code_2": "string",
- "code_3": "string"
}
}
]
}This document's public part as OpenAPI 3.1 JSON: the public routes, the schemas they use, and this site as the server. Point an OpenAPI client, a code generator or an assistant at it; the site's llms.txt links to it.
Ask for application/json (any Accept that allows it, */* included). An Accept that allows only JSON:API answers 406, as Joomla answers a format a route does not serve.
{- "openapi": "string",
- "info": {
- "title": "string",
- "version": "string"
}, - "servers": [
- {
- "url": "string"
}
], - "security": [ ],
- "tags": [ ],
- "paths": { },
- "components": { }
}