POST list_guests
Guests with their list (Definitely Invited or Maybe), events invited to and RSVP state.
read
Returns the guests on your guest list, each with the list they are on, the events they are invited to and their reply per event. Contact details are left out unless include_contact is true. Use guest_id from each item in the other tools.
POST /api/v1/zola/list_guests
Input
| Parameter | Type | Description |
|---|---|---|
| list | enum | definitely_invited, maybe or all. Default: all. |
| include_contact | boolean | Add mailing address, email and phone. Default: false. |
| search | string | Match on guest name. |
Example response
{
"guests": [
{
"guest_id": "gst_a41c07",
"name": "Maria Example",
"list": "definitely_invited",
"events": [
{
"event_id": "evt_ceremony",
"rsvp": "attending"
},
{
"event_id": "evt_reception",
"rsvp": "no_response"
}
]
},
{
"guest_id": "gst_a41c08",
"name": "Tom Example",
"list": "definitely_invited",
"events": [
{
"event_id": "evt_ceremony",
"rsvp": "declined"
}
]
}
]
}