Get Reservation

Get a reservation by its unique identifier.

HTTP Request

GET https://dev.calry.app/api/v1/vrs/reservations/{reservationId}

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN
workspaceId	YOUR_WORKSPACE_ID
integrationAccountId	YOUR_INTEGRATION_ACCOUNT_ID

Query Parameters

Parameter	Type	Description
realtime	bool	If true, the response will be streamed in real-time.

Example Request

curl --location 'https://dev.calry.app/api/v1/vrs/reservations/123456' \
--header 'Authorization: Bearer eyJraWQiOiJzLWE5MGU1M2Q0LTJiNzktNDc2ZS1iNDA0LWI2YzQ2MzE2NmY5ZCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjVlNWRkMWE2LTA5NGItNDI4ZS1hMDRmLTBmMmUyMDgwMTgxZiIsIndvcmtzcGFjZUlkIjoiNzI0NmU0ZjUtZDhmMi00YzAxLWFiYjctNzUzYjlkZjJkMzFmIiwibmFtZSI6InRlc3QtdG9rZW4iLCJzb3VyY2UiOiJtaWNyb3NlcnZpY2UiLCJpYXQiOjE3MDA0Nzc0NDksImV4cCI6MTcwMDgzNzQ0OX0.XqZs7DfFI4PuxkNi3fxPZ-xKcNUtWdhUpVf34B05xRxkWqxlRYSO8OPTg6GEPmnAHwVknKdHzLukAowH4MPpHVTTIPM7gVdhkwCcI-sfJ_HFiBxT-myDN1pQGlp8uHbg0TmiOWe23ENuqAfIIAY_XZa6TzzOQdQqCGodtF3BvB1mxBD-eQHTSY4VLk2zC2QY1vWIKMa_scWUWUJ4lqtqwawKUVOQlz2Hm_W7Z9RBF7InJbrLBYK1EB6YSVLyeBz1Y-CdysBupuYn2130MXHauPNZcf9z_05g59XBXMW5_Qstcs-EaEntw' \
--header 'workspaceId: 7246e4f5-d8f2-4c01-abb7-753b9df2d31f' \
--header 'integrationAccountId: a2e1738e-9e30-4ba0-808a-fd3f1ce6369a'

Example Response

{
    "data":
   {
        "id": 23609077,
        "createdAt": "2024-01-23T22:30:18.000Z",
        "updatedAt": "2024-01-23T22:30:18.000Z",
        "cancelledAt": "",
        "arrivalDate": "2024-03-10T00:00:00.000Z",
        "departureDate": "2024-03-12T00:00:00.000Z",
        "nights": 2,
        "propertyId": 212815,
        "numberOfGuests": 3,
        "primaryGuest": {
            "name": "Alice Johnson",
            "emails": [
                "alicej@example.com"
            ],
            "nameLast": "Johnson",
            "pictures": [
                null
            ],
            "addresses": {
                "city": "Laketown",
                "line1": "456 Oak Lane Suite 12",
                "country": "Wonderland",
                "postal_code": "67890"
            },
            "nameFirst": "Alice",
            "mobileNumbers": [
                "+9876543210"
            ],
            "preferredLanguage": {
                "code": null,
                "name": ""
            }
        },
        "numberOfAdults": 2,
        "numberOfChildren": 1,
        "numberOfInfants": 0,
        "numberOfPets": 1,
        "source": "direct",
        "totalPrice": 950,
        "currency": "USD",
        "status": "new",
        "arrivalEstimatedTime": "09:30:00.000Z",
        "departureEstimatedTime": "06:30:00.000Z",
        "notes": "Need a crib for the child.",
        "verification": {
            "isEmailVerified": false,
            "isPhoneVerified": false,
            "isIdentityVerified": false,
            "isGovernmentIdVerified": false
        },
        "finances": {
            "fee": {
                "totalFee": 0,
                "breakdown": []
            },
            "tax": {
                "totalTax": 0,
                "breakdown": []
            },
            "currency": "USD",
            "discount": {
                "breakdown": [],
                "totalDiscount": 0
            },
            "basePrice": {
                "breakdown": [
                    {
                        "name": "Base rate",
                        "type": "BASE_PRICE",
                        "total": 950,
                        "units": 1,
                        "description": "Base rate",
                        "isMandatory": true
                    },
                    {
                        "name": "Total price from channel",
                        "type": "BASE_PRICE",
                        "total": 950,
                        "units": 1,
                        "description": "Total price from channel",
                        "isMandatory": false
                    }
                ],
                "totalBasePrice": 1900
            },
            "totalPrice": 950,
            "paymentStatus": "Unknown",
            "remainingBalance": null
        }
    }
}