Get All Guests

Get all guests for a given the user.

HTTP Request

GET https://dev.calry.app/api/v1/vrs/guests

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/guests?realtime=true' \
--header 'Authorization: Bearer eyJraWQiOiJzLWE5MGU1M2Q0LTJiNzktNDc2ZS1iNDA0LWI2YzQ2MzE2NmY5ZCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjVlNWRkMWE2LTA5NGItNDI4ZS1hMDRmLTBmMmUyMDgwMTgxZiIsIndvcmtzcGFjZUlkIjoiNzI0NmU0ZjUtZDhmMi00YzAxLWFiYjctNzUzYjlkZjJkMzFmIiwibmFtZSI6InRlc3QtdG9rZW4iLCJzb3VyY2UiOiJtaWNyb3NlcnZpY2UiLCJpYXQiOjE3MDA0Nzcaa0NDksImV4cCI6MTcwMDgzNzQ0OX0.XqZs7DfFI4PuxkNi3fxPZ-xKcNUtWdhUpVf34B05xRxkWqxlRYSO8OPTg6GEPmnAHwVknKdHzLukAowH4MPpHVTTIPM7gVdhkwCcI-sfJ_HFiBxT-myDN1pQGlp8uHbg0TjhG8xamkxsgQxB1mxBD-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": "12345",
            "created_at": "2023-10-25T12:34:56Z",
            "name_prefix": "Mr.",
            "name_first": "John",
            "name_last": "Doe",
            "sexCode": 1,
            "emails": ["john.doe@example.com"],
            "mobile_numbers": [1234567890],
            "preferred_language": "en",
            "nationality": "USA",
            "company_names": ["Doe Industries"],
            "notes": "Regular guest, prefers quiet rooms.",
            "documents": [
                {
                    "type": "Passport",
                    "number": "X1234567"
                },
                {
                    "type": "Driving Licence",
                    "number": "Y7654321"
                }
            ],
            "pictures": [
                {
                    "url": "http://example.com/john_doe_pic1.jpg"
                },
                {
                    "url": "http://example.com/john_doe_pic2.jpg"
                }
            ],
            "addresses": [
                {
                    "line1": "123 Elm St.",
                    "line2": "Apt 4B",
                    "postal_code": "12345",
                    "city": "Sample City",
                    "state": "NY",
                    "country": "USA"
                }
            ],
            "preferences": ["K1", "NS", "HF"]
        }
    ],
    "meta": {
        "limit": 10,
        "cursors": {
            "previous": "",
            "current": "1",
            "next": ""
        }
    }
}