Params

NameTypeRequirenessDefault valueDescription
guest_uidsstringoptionalnoneList of comma separated guest UIDs
platform_typestringoptionalnoneList of comma separated platform types (see the corresponding filters section). This filter returns guests related to one of mentioned platform types
pageintoptional1Page number for pagination

Description

List of all guests

This endpoint requires the following scope: messaging

Response sample

{
    "data": [
        {
            "guest_uid": "456_airbnb",
            "platform_type": "airbnb",
            "name": "Jane Roe"|null,
            "thumbnail_url": "https://a0.muscache.com/im/pictures/5174e35a-fbd9-4286-887d-f5f0e7296b68.jpg"|null,
            "email": [
                "jane@example.org",
                "janeroe@example.org"
            ],
            "phone_number": [
                "555-01-65",
                "555-11-32"
            ]
        }
    ],
    "meta": {
        "page": 1,
        "has_next_page": false,
    }
}