GET /v1/reservations
List reservations
Returns all reservations for the company with guest details, room info, and payment status
Request
GET /v1/reservations
Parameters
[
{
"schema": {
"type": "string",
"default": "1"
},
"required": false,
"name": "page",
"in": "query"
},
{
"schema": {
"type": "string",
"default": "20"
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "company_id",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "property_id",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "room_id",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"confirmed",
"pending",
"cancelled",
"completed",
"no_show"
]
},
"required": false,
"name": "status",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "check_in_from",
"in": "query"
},
{
"schema": {
"type": "string"
},
"required": false,
"name": "check_in_to",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"airbnb",
"booking",
"ets",
"otelz",
"direct"
]
},
"required": false,
"name": "provider",
"in": "query"
}
]
Response
{
"200": {
"description": "Reservations retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"reservations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"provider": {
"type": [
"string",
"null"
]
},
"external_id": {
"type": [
"string",
"null"
]
},
"check_in": {
"type": "string"
},
"check_out": {
"type": "string"
},
"nights": {
"type": "number"
},
"adults": {
"type": "number"
},
"children": {
"type": "number"
},
"total_amount_cents": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "string"
},
"created_at": {
"type": "string"
},
"guest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"full_name",
"email",
"phone"
]
},
"room": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"room_type": {
"type": "string"
}
},
"required": [
"id",
"name",
"room_type"
]
},
"property": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
}
},
"required": [
"id",
"provider",
"external_id",
"check_in",
"check_out",
"nights",
"adults",
"children",
"total_amount_cents",
"currency",
"status",
"created_at",
"guest",
"room",
"property"
]
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
}
},
"required": [
"page",
"limit",
"total",
"total_pages",
"has_next",
"has_prev"
]
},
"summary": {
"type": "object",
"properties": {
"total_reservations": {
"type": "number"
},
"total_revenue": {
"type": "number"
},
"confirmed_count": {
"type": "number"
},
"pending_count": {
"type": "number"
},
"cancelled_count": {
"type": "number"
}
},
"required": [
"total_reservations",
"total_revenue",
"confirmed_count",
"pending_count",
"cancelled_count"
]
}
},
"required": [
"reservations",
"pagination",
"summary"
]
}
},
"required": [
"success",
"data"
]
}
}
}
}
}
View in Interactive API Reference