Skip to Content
Guests

Export a guest's data

Everything held about one email address, for a data access request. Requires the `rsvps:read` scope.

GET
/v1/guests/export

Everything held about one email address, for a data access request.

Requires the rsvps:read scope.

Authorization

secretKey
headerAuthorizationBearer <token>

A secret key: wc_live_... or wc_test_.... Keep it on your server.

Query Parameters

email*string

The guest's email address.

Formatemail
Lengthlength <= 320

Response Body

The guest's data.

application/json
  1. response

Everything the organization holds about one guest.

email*string
mode*string

live or test. Always the mode of the API key that made the request.

Value in"live""test"
exported_at*string

ISO 8601 with a UTC offset.

Formatdate-time
rsvps*array<>

Every RSVP for this email in the organization, with its event.

Example Request
curl -X GET 'https://api.whocoming.com/v1/guests/export?email=user%40example.com'
Example Response
{  "email": "string",  "mode": "live",  "exported_at": "2019-08-24T14:15:22Z",  "rsvps": [    {      "id": "string",      "event_id": "string",      "mode": "live",      "name": "string",      "email": "string",      "status": "going",      "guests": 0,      "answers": {        "property1": "string",        "property2": "string"      },      "source": "embed",      "locked": true,      "checked_in_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "event": {        "id": "string",        "title": "string",        "starts_at": "2019-08-24T14:15:22Z",        "timezone": "string"      }    }  ]}