v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Knowledge Base

Query Knowledge Bases

You can query knowledge base entries by making a request to this endpoint. Results are paginated and can be filtered by property or channel.

get/knowledge_bases

Query parameters

offsetinteger

Zero-based index of the first row to return. Default: 0.

limitinteger

Maximum number of rows to return (1–100). Default: 10.

property_idsstring

Filter by property IDs. Comma-separated integer IDs (e.g. 1,2,3).

channel_typesstring

Filter by channel types. Comma-separated channel names, e.g. airbnb,booking.com.

Response

A paginated list of knowledge base entries

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}