Guests

List guests

get/guests

Request

  • Base URL: https://api.aisle.wedding/v1
  • URL: https://api.aisle.wedding/v1/guests
  • Auth: HTTP bearer

Query parameters

party_idstring[]

Return guests belonging to this party public ID. Repeat the parameter, or comma-separate its values, to match any of them.

rsvp_statusstring[]

Return only guests with this headline RSVP status. Repeat the parameter, or comma-separate its values, to match any of them.

rsvp_stagestring[]

Return only guests at this RSVP stage. Stages are free-form, so an unused value is an empty page rather than an error. Repeat the parameter, or comma-separate its values, to match any of them.

limitinteger

How many records to return, 1 to 100.

cursorstring

The next_cursor from the previous page. Omit for the first page.

Response

A page of guests.

has_moreboolean required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "rsvp_responded_at": "2026-08-31T01:58:35.000Z",
      "email_opted_out_at": "2026-08-31T01:58:35.000Z",
      "whatsapp_opted_in_at": "2026-08-31T01:58:35.000Z",
      "created_at": "2026-08-31T01:58:35.000Z",
      "updated_at": "2026-08-31T01:58:35.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.