---
title: Agenda API
slug: docs/agenda-api
createdAt: 2025-12-11T23:06:40.061Z
---

The Agenda API is an endpoint that returns Agenda information for a given Event ID. It returns a list of Sessions, along with their Locations, Session Speaker information, and filtering attributes (Traits and Trait Groups) - that allow you to present Agenda information on event websites, event apps, and more.&#x20;

The endpoint is setup and ready to be directly consumed by clients such as websites or event apps without any additional infrastructure of caching required on your end. Global data and image CDN and caching is available out of the box.&#x20;

The Agenda API must be enabled on a per-event basis in the Jomablue portal.

:::hint{type="info"}
**CORS** - A note on CORS for front end consumers of this API. Within the Jomablue portal, CORS configurations can be configured on a per-event basis to allow your front ends to directly consume data from Jomablue APIs.&#x20;
:::

## Setup

Two settings control what the Agenda API returns. Both are off by default.

### 1. Enable the API for the event

In the Jomablue portal, go to **Event Configuration > Public Agenda API** and set **Enable Public Agenda API** to **Yes**.

While this setting is off, the endpoint returns `404 Not Found` for the event, and the Session setting below is not shown in the portal.

### 2. Choose which Sessions to include

Each Session has a **Visible in Public Agenda API** setting. Only Sessions set to **Yes** are returned. New Sessions are set to **No**, so a Session is excluded until you include it.

Inactive Sessions are never returned.

To set this for many Sessions at once, add a `visible_in_api` column to your Session import:

| Value | Result                  |
| ----- | ----------------------- |
| 1     | The Session is included |
| 0     | The Session is excluded |

Use `1` or `0` only. If you leave the column out, existing Sessions keep their current setting.

You can also set `visible_in_api` through the Ingest API Sessions endpoint (see [Ingest API Session Mapping](https://apidocs.jomablue.com/docs/session-mapping)).

## Endpoint

:::BlockQuote
GET /api/agenda/&#x7B;event\_id}
:::

This request returns JSON-formatted data about the Sessions in the requested event (see the sample request and response).

## Response Codes

- **200 Accepted Request** - stored and queued for processing
- **404 Not Found** - returned if the API is disabled for the requested event

## Response Attributes

A description of each attribute in the event payload is below:

- `data` **object**&#x20;
  - `id` **string**&#x20;
    A unique identifier. Alphanumeric (upper and lower case), hyphens, forward slash and underscores. No whitespace.
  - `name` **string**&#x20;
    Event name. Alphanumeric (upper and lower case), special characters and whitespace.
  - `start_date` **timestamp**&#x20;
    Timestamp in the following format: 2025-12-08T22:00:00.000000Z
  - `end_date` **timestamp**&#x20;
    Timestamp in the following format: 2025-12-08T22:00:00.000000Z
  - `locations` **array**&#x20;
    List of all venue locations for the event.&#x20;
    - `id` **integer**&#x20;
      Unique identifier for the location.
    - `name` **string**&#x20;
      Name of the location/room.
    - `description` **string | null**
      Location description. Alphanumeric (upper and lower case), special characters and whitespace. Null if not specified.
    - `color` **string | null**
      Hex color code for the location. Null if not specified.
  - `sessions` **array**&#x20;
    List of all sessions for the event.&#x20;
    - `id` **integer**&#x20;
      Unique identifier for the session.
    - `name` **string**&#x20;
      Session name/title.
    - `description` **string | null**
      Session description in HTML format. Null if not specified.
    - `start_time` **timestamp**&#x20;
      Timestamp in the following format: 2025-12-08T11:00:00.000000Z
    - `finish_time` **timestamp**&#x20;
      Timestamp in the following format: 2025-12-08T11:30:00.000000Z
    - `restricted` **boolean**&#x20;
      Indicates whether the session has restricted access.
    - `promo_text` **string** **| null**
      Promotional text for the session. Null if not specified.
    - `promo_logo` **string** **| null**
      URL to the promotional logo image. Null if not specified.
    - `location_id` **integer**&#x20;
      References a location ID from the locations array.
    - `speakers` **array**&#x20;
      List of speakers for this session. Can be empty.
      - `id` **integer**&#x20;
        Unique identifier for the speaker.
      - `title` **string** **| null**
        Professional title of the speaker. Null if not specified.
      - `first_name` **string**&#x20;
        Speaker's first name.
      - `last_name` **string**&#x20;
        Speaker's last name.
      - `company`**string** **| null**
        Company the speaker represents. Null if not specified.
      - `description` **string** **| null**
        Speaker biography in HTML format. Null if not specified.
      - `image` **string** **| null**
        URL to the speaker's profile image. Null if not specified.
    - `trait_types` **array**&#x20;
      Custom trait types/categories associated with the session. Can be empty.
      - `id` **integer**&#x20;
        Unique identifier for the trait type.
      - `name` **string**&#x20;
        Name of the trait type (e.g., "Content type").
      - `traits` **array**&#x20;
        List of traits within this trait type.&#x20;
        - `id` **integer**&#x20;
          Unique identifier for the trait.
        - `name` **string**&#x20;
          Name of the trait (e.g., "Workshop").
        - `color` **string | null**
          Hex color code for the trait. Null if not specified.
        - `text_color` **string | null**&#x20;
          Hex color code for text. Null if not specified.



## Sample Request and Response

::::CodeDrawer{title="Sample Request" isResponseExpanded="true" autoGeneratedAnchorSlug="sample-request" legacyHash="Jo0gnRCTnNzWiNI6jv1gJ"}
:::CodeblockTabsExamples
```curl
curl -X GET https://{YOUR_INSTANCE}.jomablue.com/api/agenda/{EVENT_ID} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"
```
:::

:::CodeblockTabsResponses
```javascript
{
  "data": {
    "id": "example/event/123",
    "name": "Annual Tech Summit 2025",
    "start_date": "2025-03-15T09:00:00.000000Z",
    "end_date": "2025-03-17T18:00:00.000000Z",
    "locations": [
      {
        "id": 1,
        "name": "Main Auditorium",
        "description": "Our largest venue space with capacity for 500 attendees.",
        "log_exits": false,
        "color": "#007fc4"
      },
      {
        "id": 2,
        "name": "Breakout Room A",
        "description": "Intimate space perfect for workshops and small group discussions.",
        "log_exits": true,
        "color": "#8cc740"
      }
    ],
    "sessions": [
      {
        "id": 1,
        "name": "Opening Keynote",
        "description": "<p>Join us for an inspiring keynote address to kick off the summit.</p>",
        "start_time": "2025-03-15T09:00:00.000000Z",
        "finish_time": "2025-03-15T10:00:00.000000Z",
        "restricted": false,
        "promo_text": "Don't miss our opening keynote address!",
        "promo_logo": "https://example.com/images/keynote-promo.jpg",
        "location_id": 1,
        "speakers": [
          {
            "id": 1,
            "title": "CEO",
            "first_name": "Jane",
            "last_name": "Smith",
            "company": "Tech Innovations Inc",
            "description": "<p>Jane Smith is a visionary leader with 20 years of experience in the technology industry.</p>",
            "image": "https://example.com/images/speakers/jane-smith.jpg"
          }
        ],
        "trait_types": [
          {
            "id": 1,
            "name": "Session Type",
            "traits": [
              {
                "id": 1,
                "name": "Keynote",
                "color": "#253344",
                "text_color": null
              }
            ]
          }
        ]
      },
      {
        "id": 2,
        "name": "Workshop: Advanced React Patterns",
        "description": "<p>A hands-on workshop exploring advanced patterns in React development.</p>",
        "start_time": "2025-03-15T11:00:00.000000Z",
        "finish_time": "2025-03-15T12:30:00.000000Z",
        "restricted": true,
        "promo_text": "Learn cutting-edge React techniques from industry experts.",
        "promo_logo": "https://example.com/images/react-workshop.jpg",
        "location_id": 2,
        "speakers": [
          {
            "id": 2,
            "title": "CTO",
            "first_name": "John",
            "last_name": "Doe",
            "company": "Web Solutions Ltd",
            "description": "<p>John Doe is a renowned expert in modern web development frameworks.</p>",
            "image": "https://example.com/images/speakers/john-doe.jpg"
          },
          {
            "id": 3,
            "title": "",
            "first_name": "Sarah",
            "last_name": "Johnson",
            "company": "Frontend Masters",
            "description": "<p>Sarah Johnson specializes in React architecture and performance optimization.</p>",
            "image": "https://example.com/images/speakers/sarah-johnson.jpg"
          }
        ],
        "trait_types": [
          {
            "id": 1,
            "name": "Session Type",
            "traits": [
              {
                "id": 2,
                "name": "Workshop",
                "color": "#8cc740",
                "text_color": "#ffffff"
              }
            ]
          },
          {
            "id": 2,
            "name": "Experience Level",
            "traits": [
              {
                "id": 3,
                "name": "Advanced",
                "color": "#e6694d",
                "text_color": null
              }
            ]
          }
        ]
      }
    ]
  }
}
```
:::
::::

## Considerations

- **Date/Time Stamps**
  All datetimes are formatted as ISO-8601 (e.g. `2025-03-15T09:00:00.000000Z`)
- **Traits**
  These are logical groupings of sessions by arbitary attributes. You can think of 'traits' as filters you would apply to a list of session (like. 'Tech' 'DevOps' 'Sales' 'Marketing' etc) and trait groups as a grouping of filters, like 'Technical' and 'Management' - where 'Tech' and 'DevOps' would sit under 'Technical' and 'Sales' and 'Marketing' sit under 'Management'. Traits and Trait Groups are configured in the Jomablue portal.

