> For the complete documentation index, see [llms.txt](https://everyday-digital.gitbook.io/falkor-dev-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://everyday-digital.gitbook.io/falkor-dev-docs/pathways/events-and-bookings/list.md).

# List

The **event list endpoint** allows you to list [events](https://docs.falkor.io/pathways/events-classroom) 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](https://docs.falkor.io/pathways/create-a-pathway), 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": "test@example.com",
                            "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.&#x20;

{% content-ref url="/pages/-MILDGEubhXzT9kQLGVZ" %}
[Consume](/falkor-dev-docs/pathways/events-and-bookings/consume.md)
{% endcontent-ref %}

| 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                                                          |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://everyday-digital.gitbook.io/falkor-dev-docs/pathways/events-and-bookings/list.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.