List

The event list endpoint allows you to list events for a specific search. If a search is not provided, it will return all events.

Parameters

Key	Type
search	Array String (pathway / event name or ID)
DEPRECATED
keyword	String (Keyword search of pathways, events or eventIDs)

Example

The example below searches for an event. This returns an array of matched events with a list of attendees and their states.

curl -X POST \
  v1/event/list \
  -H 'Authorization: Basic <Your Base64 Encoded Token>' \
  -d '{
	"search" : ["Event A",...]
}'

Success Response

The response will contain an array of pathway reward combination objects containing pathway details and events (which is the list of events on the pathway). This is the same structure as the event webhook payload.

{
    "status": "success",
    "data": [
        {
            "pathway": {
                "name": "My Pathway",
                "ID": "FA-HCPG-06RF"
            },
            "events": [
                {
                    "ID": "FABK-YVUU-89RU",
                    "type": "event",
                    "name": "Event",
                    "start": "2020-10-15T16:15:00+02:00",
                    "end": "2020-10-15T22:15:00+02:00",
                    "venue": {
                        "place": "Cable Car Station",
                        "location": "Cape Town ZA"
                    },
                    "available": "4",
                    "booked": "2",
                    "attendees": [
                        {
                            "guid": "8bd0705f-c640-4191-9a1c-1a8cc73ad949",
                            "state": "booked",
                            "firstname": "Test",
                            "lastname": "User",
                            "email": "[e-mail]",
                            "country": "South Africa",
                            "city": "Cape Town"
                        },
                        ...etc
                    ]
                },
                ...etc
            ]
        },
        ...etc
    ],
    "hash": "5c1f0ee1e0af27b79b1fa4e17f571f1c",
    "response_time": 0.13155317306518555
}

Key	Type
pathway	Object. The name and SKU of the related pathway.
events	Array. A list of events.

Event Object

Key	Type
ID	String. ID or SKU reference of the event.
name	String. Name of the event.
start	String. Start time of the event.
end	String. End time of the event.
venue	Object. Venue information.
booked	String. Number of registered attendees.
available	String. Available capacity (Unlimited or number)
attendees	Array. A list of registered attendees.

Attendee Object

The attendee object will contain a guid which is used in the consume endpoint for events. This will allow integrations to set the booking state if the intention is to manage attendance of events via external systems.

Consume

Key	Type
guid	String. A GUID of the attendee.
state	String. The state of the attendance (booked, absent, attended).
firstname	String
lastname	String
email	String
country	String
city	String