--- updatedAt: 2025-09-09T21:11:17.000Z agentTools: projectIndex: https://docs.ciiruspartners.com/v2023.07.31/llms.txt --- # Retrieve all content details Returns details for inventory. # OpenAPI definition ```json { "openapi": "3.0.0", "security": [ { "basicAuth": [] } ], "info": { "title": "CiiRUS Partner API", "version": "2023.07.31" }, "paths": { "/content/details": { "get": { "summary": "Retrieve all content details", "description": "Returns details for inventory.", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/lastUpdateDate" }, { "$ref": "#/components/parameters/mcUserId" }, { "$ref": "#/components/parameters/mcUserIds" }, { "$ref": "#/components/parameters/unitIdQuery" }, { "$ref": "#/components/parameters/unitIdQueries" }, { "$ref": "#/components/parameters/airbnb" }, { "$ref": "#/components/parameters/deleted" } ], "responses": { "200": { "description": "Inventory details response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContentDetailsInventoryResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "tags": [ "Content (Details)" ] } } }, "servers": [ { "url": "https://api.ciiruspartners.com/v2023.07.31" } ], "components": { "parameters": { "unitIdQuery": { "name": "unitId", "in": "query", "description": "Unique Identifier for inventory.", "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "unitIdQueries": { "name": "unitIds", "in": "query", "description": "Unique Identifiers for inventory.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } }, "pageSize": { "name": "pageSize", "in": "query", "description": "Limits the number of returned results.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 25 } }, "page": { "name": "page", "in": "query", "description": "The page to be shown.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "default": 1 } }, "lastUpdateDate": { "name": "lastUpdateDate", "in": "query", "description": "Only return objects which have been modified after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "airbnb": { "name": "airbnb", "in": "query", "description": "Return additional context information relating to airbnb.", "required": false, "schema": { "type": "boolean" } }, "deleted": { "name": "deleted", "in": "query", "description": "Only show properties which are deleted or not deleted.", "required": false, "schema": { "type": "boolean" } }, "mcUserId": { "name": "mcUserId", "in": "query", "description": "Unique Identifier for supplier.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "mcUserIds": { "name": "mcUserIds", "in": "query", "description": "Unique Identifiers for suppliers.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } } }, "responses": { "BadRequest": { "description": "Bad Request response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Unauthorized response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Forbidden response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Not Found response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "PagedLambdaResponseObject": { "properties": { "next_page_url": { "type": "string", "format": "uri", "description": "URL to the next page (not present on last page)" }, "previous_page_url": { "type": "string", "format": "uri", "description": "URL to the previous page (not present on first page)" }, "total_page_count": { "type": "integer", "format": "int32", "minimum": 0, "description": "Total number of pages available" } }, "required": [ "total_page_count" ] }, "text_type": { "properties": { "text_type": { "type": "string", "enum": [ "PlainTextDescription", "PlainTextLocation", "Headline", "Title", "Overview", "BulletPointOne", "BulletPointTwo", "BulletPointThree", "BulletPointFour", "BulletPointFive" ] } } }, "GetContentDetailsInventoryResponse": { "properties": { "properties": { "type": "array", "items": { "$ref": "#/components/schemas/GetContentDetailsResponseObject" } } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/components/schemas/PagedLambdaResponseObject" }, { "type": "object" } ] }, "GetContentDetailsResponseObject": { "properties": { "property_id": { "type": "integer", "format": "int32" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ContentDetailsObject" } } }, "required": [ "property_id", "details" ] }, "ContentDetailsObject": { "properties": { "description_set_id": { "type": "integer" }, "active": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/ContentDetailsAddressObject" }, "location": { "$ref": "#/components/schemas/ContentDetailsLocationObject" }, "geo_code": { "$ref": "#/components/schemas/ContentDetailsGeoCodeObject" }, "terms_and_conditions": { "$ref": "#/components/schemas/ContentDetailsTermsAndConditionsObject" }, "description": { "$ref": "#/components/schemas/ContentDetailsDescriptionObject" }, "arrival_time": { "type": "string" }, "departure_time": { "type": "string" }, "area": { "type": "integer" }, "area_unit": { "type": "string" }, "max_occupants": { "type": "integer" }, "bedrooms": { "type": "integer" }, "king_beds": { "type": "integer" }, "queen_beds": { "type": "integer" }, "full_beds": { "type": "integer" }, "single_twin_beds": { "type": "integer" }, "bathrooms": { "type": "number" }, "class": { "type": "string", "enum": [ "Standard", "Superior", "Deluxe", "Ultimate", "SuperiorDeluxeWithGameRoomSpa", "Special" ] }, "type": { "type": "string" }, "restrictions": { "$ref": "#/components/schemas/ContentDetailsRestrictionsObject" }, "channel_ids": { "$ref": "#/components/schemas/ContentDetailsChannelIdsObject" }, "tax_1_remitted_by_host": { "type": "boolean" }, "tax_2_remitted_by_host": { "type": "boolean" }, "tax_3_remitted_by_host": { "type": "boolean" }, "commercial": { "type": "boolean" }, "furnished": { "type": "boolean" }, "long_term": { "type": "boolean" } }, "required": [ "description_set_id", "active", "address", "geo_code", "description", "arrival_time", "departure_time", "area", "area_unit", "max_occupants", "bedrooms", "king_beds", "queen_beds", "full_beds", "single_twin_beds", "bathrooms", "class", "type", "restrictions", "commercial", "furnished", "long_term" ] }, "ContentDetailsAddressObject": { "properties": { "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "city": { "type": "string" }, "state_province": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" }, "country_code": { "type": "string" } }, "required": [ "address_line_1", "address_line_2", "city", "state_province", "country", "postal_code", "country_code" ] }, "ContentDetailsLocationObject": { "properties": { "id": { "type": "string" }, "community": { "type": "string" }, "lat": { "type": "integer", "multipleOf": 1e-15 }, "long": { "type": "integer", "multipleOf": 1e-15 }, "gated": { "type": "boolean" }, "city": { "$ref": "#/components/schemas/ContentDetailsCityObject" } }, "required": [ "id", "community", "lat", "long", "gated", "city" ] }, "ContentDetailsCityObject": { "properties": { "id": { "type": "string" }, "city": { "type": "string" }, "lat": { "type": "integer", "multipleOf": 1e-15 }, "long": { "type": "integer", "multipleOf": 1e-15 }, "state": { "$ref": "#/components/schemas/ContentDetailsStateObject" } }, "required": [ "id", "city", "lat", "long", "state" ] }, "ContentDetailsStateObject": { "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "lat": { "type": "integer", "multipleOf": 1e-15 }, "long": { "type": "integer", "multipleOf": 1e-15 }, "country": { "$ref": "#/components/schemas/ContentDetailsCountryObject" } }, "required": [ "id", "state", "lat", "long", "country" ] }, "ContentDetailsCountryObject": { "properties": { "id": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "lat": { "type": "integer", "multipleOf": 1e-15 }, "long": { "type": "integer", "multipleOf": 1e-15 } }, "required": [ "id", "country", "country_code", "lat", "long" ] }, "ContentDetailsGeoCodeObject": { "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "required": [ "latitude", "longitude" ] }, "ContentDetailsTermsAndConditionsObject": { "properties": { "id": { "type": "number" }, "mc_user_id": { "type": "number" }, "terms_name": { "type": "string" }, "plain_text_terms": { "type": "string" }, "cancellation_policy": { "type": "string" }, "local_charges": { "type": "string" }, "language_id": { "type": "number" } }, "required": [ "id", "mc_user_id", "terms_name", "plain_text_terms", "cancellation_policy", "local_charges", "language_id" ] }, "ContentDetailsDescriptionObject": { "properties": { "text": { "type": "string" } }, "required": [ "text_type", "text" ], "allOf": [ { "$ref": "#/components/schemas/text_type" } ] }, "ContentDetailsRestrictionsObject": { "properties": { "min_guest_age": { "type": "integer" }, "smoking_allowed": { "type": "boolean" }, "pets_allowed": { "type": "boolean" }, "surveillance": { "type": "boolean" } }, "required": [ "min_guest_age", "smoking_allowed", "pets_allowed", "surveillance" ] }, "ContentDetailsChannelIdsObject": { "properties": { "airbnb": { "type": "string" }, "booking_dot_com": { "type": "string" }, "booking_sync": { "type": "string" }, "booking_pals": { "type": "string" }, "expedia": { "type": "string" }, "guesty": { "type": "string" }, "vrbo": { "type": "string" }, "orbirental": { "type": "string" }, "rentals_united": { "type": "string" }, "site_minder": { "type": "string" }, "trip_advisor": { "type": "string" }, "wheelhouse": { "type": "string" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```