---
title: Endpoints
description: Endpoints
---

[Skip to content](https://kbm.broadercaster.com/api-endpoints#main-content)

[Submit A Ticket](https://kbm.broadercaster.com/kb-tickets/new?hsLang=en-au)

[![Broadercaster200x50](https://kbm.broadercaster.com/hs-fs/hubfs/Broadercaster200x50.png?width=200&height=50&name=Broadercaster200x50.png)](https://kbm.broadercaster.com/?hsLang=en-au)

Open main navigation

Close main navigation

- [Submit A Ticket](https://kbm.broadercaster.com/kb-tickets/new)

 How can we help you today ?

- There are no suggestions because the search field is empty.

1. [Broadercaster](https://kbm.broadercaster.com/?hsLang=en-au)
2. [API](https://kbm.broadercaster.com/api?hsLang=en-au)

# Endpoints

### 1. Upcoming Events

```
GET /api/event/upcoming
```

Returns a list of upcoming funeral events for the organisation.

**Parameters:**

- `page` (optional, integer, default: 1): Page number for pagination.
- `rowPerPage` (optional, integer, default: 100): Number of records to return per page.

**Example Request:**

```
GET /api/event/upcoming?page=2&rowPerPage=50
```

### 2. Live Events

```
GET /api/event/live
```

Returns a list of currently live events for the organisation.

**Parameters:** Same as "Upcoming Events"

**Example Request:**

```
GET /api/event/live
```

### 3. Completed Events

```
GET /api/event/completed
```

Returns a list of completed events for the organisation.

**Parameters:** Same as "Upcoming Events"

**Example Request:**

```
GET /api/event/completed?page=1&rowPerPage=200
```

### 4. Search Events by Name

```
GET /api/event/search
```

Searches for funeral events by first and/or last name within the organisation.

**Parameters:**

- `firstName` (optional, string): First name to search for.
- `lastName` (optional, string): Last name to search for.
- `page` (optional, integer, default: 1): Page number for pagination.
- `rowPerPage` (optional, integer, default: 100): Number of records to return per page.

**Example Request:**

```
GET /api/event/search?firstName=John&lastName=Doe&page=1
```

### 5. Get Event by ID

```
GET /api/event/id/{eventId}
```

Returns a specific event by its ID.

**Parameters:**

- `eventId` (required, GUID): The unique identifier of the event.

**Example Request:**

```
GET /api/event/id/a1b2c3d4-e5f6-7890-1234-567890abcdef
```

### 6. Get Event by External ID

```
GET /api/event/id/external/{externalId}
```

Returns a specific event by its external identifier.

**Parameters:**

- `externalId` (required, string): The external identifier of the event.

**Example Request:**

```
GET /api/event/id/external/ext-12345
```

### 7. Create Event

```
POST /api/event
```

Creates a new event for the organisation.

**Request Body:**

- `FuneralEventUpsertDTO` object containing the event data.

**Returns:**

- List of validation errors (empty if successful)

### 8. Update Event

```
PUT /api/event/id/{eventId}
```

Updates an existing event within an organisation.

**Parameters:**

- `eventId` (required, GUID): The unique identifier of the event to update.

**Request Body:**

- `FuneralEventUpsertDTO` object containing the updated event data.

**Returns:**

- List of validation errors (empty if successful)

### 9. Get Inputs

```
GET /api/input
```

Returns a list of available inputs for the organisation.

**Example Request:**

```
GET /api/input
```

### 10. Get Divisions

```
GET /api/division
```

Returns a list of divisions for the organisation.

**Example Request:**

```
GET /api/division
```

- [Introduction](https://kbm.broadercaster.com/introduction?hsLang=en-au)
- [Tutorials](https://kbm.broadercaster.com/tutorials?hsLang=en-au)
- [Images](https://kbm.broadercaster.com/images?hsLang=en-au)
- [API](https://kbm.broadercaster.com/api?hsLang=en-au)
- [Wordpress Plugin](https://kbm.broadercaster.com/wordpress-plugin?hsLang=en-au)
- [Demonstration Website](https://kbm.broadercaster.com/demonstration-website?hsLang=en-au)
- [Support](https://kbm.broadercaster.com/support?hsLang=en-au)

Copyright © 2025,