get https://api.swoogo.com/api/v1/sessions
Sessions
This endpoint returns a collection response. Each entry of the collection contains the details for one item. You can control which details are returned by specifying the fields parameter. Use the expand parameter to include related objects. Use the response's pagination parameters to navigate through the entire collection.
Available Fields
These are the standard fields available for configuring a session:
| Name | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the session. |
event_id |
integer | ID of the event associated with this session. |
name |
string | Title or name of the session. |
admin_short_name |
string | Admin-specific short name for internal usage. |
badge_name |
string | Display name on attendee badges. |
description |
string | Detailed description of the session. |
date |
string (date) | The date when the session will take place. |
start_time |
string (time) | Start time of the session. |
end_time |
string (time) | End time of the session. |
use_event_timezone |
integer | Whether the event's default timezone is applied to the session. |
timezone |
string | Timezone for the session (see TZ Identifier column in the List of TZ Database Time Zones). |
capacity |
integer | Maximum number of attendees allowed. |
location_id |
integer | Identifier for the location. |
track_id |
integer | Identifier for the session's track. |
selection_control |
string | Specifies whether the session is optional or included by default, setting the value 'session_included'. |
webinar_url |
string (uri) | URL for the webinar if the session is virtual. |
sold_out_message |
string | Custom message displayed when the session is sold out. |
secure_id |
string | Secure identifier for the session. |
session_status |
string | Current status of the session. Possible values: submitted, approved, rejected, converted, live. |
locked_when_saved |
boolean | Whether the session is locked after being saved. |
selected_by_default |
boolean | Indicates if the session is selected by default for attendees. |
prevent_session_conflicts |
boolean | Whether should prevent conflicts with other sessions when selecting this session. |
custom_fields |
object | Custom fields associated with the session. Key-value pairs can be dynamic. |
Extra Fields
This is the extra information that can be returned if required by specifying what you need in the expand variable:
| Name | Type | Description |
|---|---|---|
speakers |
object | List of speakers assigned to this session |
location |
object | Selected Location for this event |
track |
object | Selected track for this event |
translations |
object | Custom translations set for this event |
sessionAttendance |
object | Session Attendance Information |
registrantCount |
object | Number of Registrants registered to this session |
reservedCount |
object | Number of Reserved seats for this session |