Agenda API
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.
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.
The Agenda API must be enabled on a per-event basis in the Jomablue portal.
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.
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 MappingIngest API Session Mapping).
Endpoint
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
- id string A unique identifier. Alphanumeric (upper and lower case), hyphens, forward slash and underscores. No whitespace.
- name string Event name. Alphanumeric (upper and lower case), special characters and whitespace.
- start_date timestamp Timestamp in the following format: 2025-12-08T22:00:00.000000Z
- end_date timestamp Timestamp in the following format: 2025-12-08T22:00:00.000000Z
- locations array List of all venue locations for the event.
- id integer Unique identifier for the location.
- name string 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 List of all sessions for the event.
- id integer Unique identifier for the session.
- name string Session name/title.
- description string | null Session description in HTML format. Null if not specified.
- start_time timestamp Timestamp in the following format: 2025-12-08T11:00:00.000000Z
- finish_time timestamp Timestamp in the following format: 2025-12-08T11:30:00.000000Z
- restricted boolean 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 References a location ID from the locations array.
- speakers array List of speakers for this session. Can be empty.
- id integer Unique identifier for the speaker.
- title string | null Professional title of the speaker. Null if not specified.
- first_name string Speaker's first name.
- last_name string Speaker's last name.
- companystring | 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 Custom trait types/categories associated with the session. Can be empty.
- id integer Unique identifier for the trait type.
- name string Name of the trait type (e.g., "Content type").
- traits array List of traits within this trait type.
- id integer Unique identifier for the trait.
- name string Name of the trait (e.g., "Workshop").
- color string | null Hex color code for the trait. Null if not specified.
- text_color string | null Hex color code for text. Null if not specified.
Sample Request and Response
curl -X GET https://{YOUR_INSTANCE}.jomablue.com/api/agenda/{EVENT_ID} \
-H "Content-Type: application/json" \
-H "Accept: application/json"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.