• Developer Home
• API Documentation
• Get API Key
• Sign Up Log In

API Documentation

All packages include API access to remotely sync the SCHED* database with your existing event database.

The API uses a simple REST method and we recommend using POST instead of GET. HTML data is only allowed for specified fields.

To create and edit SCHED* sites, use the methods below by passing the appropriate field values.

SITE: ADD URL: http://schedapi.sched.org/api/site/add

        {
          "site": "http://myconf.sched.org",
          "user":
            {
              "username": "myconf-admin",
              "email":"admin@example.com",
              "login":"http://myconf.sched.org/editor",
              "reset":"http://myconf.sched.org/password-new?user=myconf-admin&reset=NONCE_KEY"
            }
        }
        

Sync styling and naming info.

SITE: SYNC URL: http://your_conference.sched.org/api/site/sync

        {"title": "Your Conference",
        "base":"http://your_conference.sched.org",
        "apikey":"secret",
        "modified":1327416542,  // timestamp of last modified
        "dates":  {},           // list of dates
        "venues": {},           // list of venues
        "types":  {},           // list of types
        "style":  ""            // CSS styles
        }
        

To populate the Event table, use the methods below by passing the appropriate field values.

EVENT: ADD URL: http://your_conference.sched.org/api/event/add

EVENT: MODIFY URL: http://your_conference.sched.org/api/event/mod

EVENT: DELETE URL: http://your_conference.sched.org/api/event/del

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.

The following API methods let you retrieve data from the Event and User tables in CSV and JSON formats.

EVENT: LIST URL: http://your_conference.sched.org/api/event/list

EVENT: COUNT URL: http://your_conference.sched.org/api/event/count

USER: LIST URL: http://your_conference.sched.org/api/user/list

Create user account

USER: ADD URL: http://your_conference.sched.org/api/user/add

USER: ACTIVE URL: http://your_conference.sched.org/api/user/active

USER: AVATAR URL: http://your_conference.sched.org/api/user/avatar

USER: EVENTS URL: http://your_conference.sched.org/api/user/events

The following API methods let you add users to event and to retrieve data about event attendees in JSON format.

NOTE: most of these methods require your application to have valid user session key.
Session key is obtained via http://your_conference.sched.org/api/auth/login with proper user credentials.

AUTH: LOGIN URL: http://your_conference.sched.org/api/auth/login

GOING: ADD URL: http://your_conference.sched.org/api/going/add

GOING: DEL URL: http://your_conference.sched.org/api/going/del

GOING: SCHEDULE URL: http://your_conference.sched.org/api/going/schedule

GOING: ALL URL: http://your_conference.sched.org/api/going/all

GOING: LIST URL: http://your_conference.sched.org/api/going/list

Get HTML formatted schedule for mobile display

SCHEDULE: GET URL: http://your_conference.sched.org/api/schedule/get

Get HTML formatted schedule for mobile display

ASSETS: BANNER URL: http://your_conference.sched.org/api/assets/banner

The following API methods let you to assign and remove roles for existing users.

These methods don't require to be authenticated as user.

ROLE: ADD URL: http://your_conference.sched.org/api/role/add

ROLE: DEL URL: http://your_conference.sched.org/api/role/del