Developer API
Use simple REST method. Recommend using POST instead of GET.
HTML data is not allowed for any fields unless clearly specified.
Ask us for your API key.
Event
To populate the event table, use the methods below by passing the appropriate field values.
Add
URL: http://your_conference.sched.org/api/event/add
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| event_key | Yes | Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. | 32 |
| name | Yes | Name of the event | 120 |
| event_start | Yes | Full date + time for start of event Format: YY-MM-DD HH:MM (2008-08-20 19:13) | 40 |
| event_end | Yes | Full date + time when event ends Format: YY-MM-DD HH:MM (2008-08-20 19:13) | 40 |
| event_type | Yes | Used to filter events | 32 |
| event_subtype | No | For additional filter/organizing events | 32 |
| description | No | Detailed description of the event Links (HTML Tag <a>) allowed. | 8kb |
| panelists | No | Detailed list of the panelists, artists, hosts Links (HTML Tag <a>) allowed. | 8kb |
| url | No | Unique external URL for this event | 250 |
| media_url | No | URL for media: audio/video/documents | 250 |
| venue | No | Building name / Company name etc. | 80 |
| address | No | Room # / Street Address | 250 |
| map | No | Direct URL for event's location / map | 250 |
| tags | No | Comma-separated words and phrases | 250 |
| Example GET Usage (all on one line) | |||
|
http://your_conference.sched.org/api/event/add?api_key=secret& event_key=kn1&name=Opening+Keynote&event_start=2008-06-12+10am event_end=2008-06-12+12:15pm&event_type=keynote&venue=Center+Hall | |||
Modify
URL: http://your_conference.sched.org/api/event/mod
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| event_key | Yes | Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. | 32 |
| name | No | Name of the event | 120 |
| event_start | No | Full date + time for start of event Format: YY-MM-DD HH:MM (2008-08-20 19:13) | 40 |
| event_end | No | Full date + time when event ends Format: YY-MM-DD HH:MM (2008-08-20 19:13) | 40 |
| event_type | No | Used to filter events | 32 |
| event_subtype | No | For additional filter/organizing events | 32 |
| description | No | Detailed description of the event Links (HTML Tag <a>) allowed. | 8kb |
| panelists | No | Detailed list of the panelists, artists, hosts Links (HTML Tag <a>) allowed. | 8kb |
| url | No | Unique external URL for this event | 250 |
| media_url | No | URL for media: audio/video/documents | 250 |
| venue | No | Building name / Company name etc. | 80 |
| address | No | Room # / Street Address | 250 |
| map | No | Direct URL for event's location / map | 250 |
| tags | No | Comma-separated words and phrases | 250 |
| active | No | Y = Event is active, N = Event is deactivated and hidden | 1 |
| Example GET Usage (all on one line) | |||
|
http://your_conference.sched.org/api/event/mod?api_key=secret& event_key=kn1&venue=Main+Auditorium | |||
Delete
URL: http://your_conference.sched.org/api/event/del
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| event_key | Yes | Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. | 32 |
| Example GET Usage (all on one line) | |||
| http://your_conference.sched.org/api/event/dell?api_key=secret&event_key=kn1 | |||
Note: The delete API only deactivates an event and hides it from the public schedule. This is the recommend way of handling cancelled events as any existing links to this event clearly display "[CANCELLED]" while still maintaining data integrity. If you want all traces of an event deleted, as if it was never entered into the Sched.org database, please contact us.