All paid plans include API access.
Our API uses a simple REST method, and we recommend using POST instead of GET. HTML data is only allowed for specified fields. You must also send requests with a User-Agent in the headers, as Sched filters out requests with no User-Agent. Limit your API usage to a rate lower than 30 calls per minute (cumulative and sustained). Failure to comply will result in a temporary revocation of your API key. Watch an introduction video here.
| API Method | Description |
|---|---|
| Site: Sync | Event info (dates, venues, types, css). |
| Session: Add | Add a new session. |
| Session: Modify | Edit an existing session. |
| Session: Delete | Delete a session. |
| Session: List | List of sessions. |
| Session: Export | List of sessions without HTML. |
| Session: Seats | Attendance lists and waitlists. |
| Session: Count | No. of sessions since a date. |
| User: List | List of users. |
| User: Add | Add a new user. |
| User: Modify | Edit an existing user. |
| User: Get | Lookup a user. |
| User: Active | List of users and last active date. |
| User: Avatar | Add an avatar/photo to a user. |
| User: Sessions | List of attendees and sessions they selected. |
| Auth: Login | Login and get authorized to add/remove sessions. |
| Going: Add | Add sessions to a user. |
| Going: Delete | Remove sessions from a user. |
| Going: Schedule | User's schedule in HTML. |
| Going: List | Single user's schedule. |
| Going: All | All users' schedules. |
| Assets: Banner | Mobile header image. |
| Role: Add | Assign a role to a user. |
| Role: Delete | Remove a role from a user. |
| Role: Export | Export users in a role. |
SITE: SYNC
View basic event info (dates, venues, types, css)
https://your_conference.sched.com/api/site/sync
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| modify_date | No | Last sync timestamp. Format: Unix timestamp | 20 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/site/sync?api_key=secret&modify_date=0 | |||
| Response | |||
JSON encoded site wording and CSS.
{
"title": "Your Conference",
"base": "https://your_conference.sched.com",
"apikey": "secret",
"modified":1327416542, // timestamp of last modified
"dates": {}, // list of dates
"venues": {}, // list of venues
"types": {}, // list of types
"style": "" // CSS styles
}
| |||
SESSION: ADD
Add a new session
https://your_conference.sched.com/api/session/add
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| session_key | Yes | Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. | 32 |
| name | Yes | Name of the session | 120 |
| session_start | Yes | Full date + time for start of session Format: YYYY-MM-DD HH:MM | 40 |
| session_end | Yes | Full date + time when session ends Format: YYYY-MM-DD HH:MM | 40 |
| session_type | Yes | Used to filter sessions | 32 |
| session_subtype | No | For additional filter/organizing sessions | 32 |
| description | No | Detailed description of the session Links (HTML Tag <a>) allowed. | 8kb |
| media_url | No | URL for media: audio/video/documents. Must use HTTPS. | 250 |
| venue | No | Building name / Company name etc. | 80 |
| address | No | Room # / Street Address | 250 |
| tags | No | Comma-separated words and phrases | 250 |
| seats | No | Venue capacity - number of available seats | 250 |
| rsvp_url | No | URL used for Custom Button | 1024 |
| ticket_message | No | Custom ticket upgrade message, displayed when attendee attempts to add the session without the correct ticket (accepts basic HTML) | 1024 |
| active | No | Y = session is active, N = session is deactivated and hidden | 1 |
| (custom fields) | No | To add custom named fields, just add your field names and their values. GET example: &Youtube Link=https://youtube.com/v/xvw123 | n/a |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/session/add?api_key=secret&session_key=kn1&name=Opening+Keynote&session_start=2008-06-12+10:00&session_end=2008-06-12+12:15&session_type=keynote&venue=Center+Hall | |||
| Using this method will automatically clear any sample/demo data that new Sched sites are pre-filled with. | |||
SESSION: MODIFY
Edit an existing session.
https://your_conference.sched.com/api/session/mod
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| session_key | Yes | Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. | 32 |
| name | No | Name of the session | 120 |
| session_start | No | Full date + time for start of session Format: YYYY-MM-DD HH:MM | 40 |
| session_end | No | Full date + time when session ends Format: YYYY-MM-DD HH:MM | 40 |
| session_type | No | Used to filter sessions | 32 |
| session_subtype | No | For additional filter/organizing sessions | 32 |
| description | No | Detailed description of the session Links (HTML Tag <a>) allowed. | 8kb |
| media_url | No | URL for media: audio/video/documents. Must use HTTPS. | 250 |
| venue | No | Building name / Company name etc. | 80 |
| address | No | Room # / Street Address | 250 |
| tags | No | Comma-separated words and phrases | 250 |
| seats | No | Venue capacity - number of available seats. | 250 |
| rsvp_url | No | URL used for Custom Button | 1024 |
| ticket_message | No | Custom ticket upgrade message, displayed when attendee attempts to add the session without the correct ticket (accepts basic HTML) | 1024 |
| active | No | Y = session is active, N = session is deactivated and hidden | 1 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/session/mod?api_key=secret&session_key=kn1&venue=Main+Auditorium | |||
SESSION: DELETE
Delete a session.
https://your_conference.sched.com/api/session/del
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| session_key | Yes | Must be a unique alpha-numeric string. E.g.: 123, PANEL4, ST45K etc. | 32 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/session/del?api_key=secret&session_key=kn1 | |||
Note: The delete API only deactivates an session and hides it from the public schedule. This is the recommend way of handling cancelled sessions as any existing links to this session clearly display "[CANCELLED]" while still maintaining data integrity.
SESSION: LIST
List of sessions.
https://your_conference.sched.com/api/session/list
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| since | No | Retrieve sessions modified since timestamp (Unix epoch time) | 4 |
| format | No | Leave blank to get CSV file or set to "json" | 40 |
| status | No | Set to "del" to fetch only references to deleted sessions | 40 |
| custom_data | No | Include this parameter with value "Y" if you have custom added fields. Note that spaces in field name will be replaced by underscores. | 1 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/session/list?api_key=secret&since=1282755813&format=json&status=del&custom_data=Y | |||
| Response | |||
| List of all conference sessions exported in CSV or JSON, depending on the "format" parameter. | |||
SESSION: EXPORT
List of sessions with HTML stripped. This is convenient for printed materials and importing into other systems.
https://your_conference.sched.com/api/session/export
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| since | No | Retrieve sessions modified since timestamp (Unix epoch time) | 4 |
| format | No | One of "csv", "xml", "json", "xls". Defaults to "csv" | 40 |
| fields | No | Comma separated list of fields wanted. Select the order of needed fields by listing them here. Leave blank to get all available fields. | 1024 |
| page | No | To page results, provide a page number. Omit to get all sessions | 8 |
| limit | No | Number of sessions per page. Defaults to 1000. | 8 |
| strip_html | No | Remove HTML tags from description | 1 |
| custom_data | No | Include this parameter with value "Y" if you have custom added fields Note that spaces in field name will be replaced by underscores. | 1 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/session/export?api_key=secret&format=xml&fields=name,session_type,description&strip_html=Y&custom_data=Y | |||
| Response | |||
| List of all conference sessions exported in CSV, JSON, XML or Excel XLS depending on the "format" parameter. | |||
SESSION: SEATS
Attendance lists and waitlists. Convenient for check-in lists and mailing lists.
https://your_conference.sched.com/api/session/seats
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| id OR key | Yes | Unique session ID or session key | 32 |
| type | No | One of "attendance", "waitlist" or "all". Defaults to "attendance" | 40 |
| format | No | One of "json", "xls" or "text". Defaults to "csv" | 40 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/session/seats?api_key=secret&type=waitlist&format=json&fields=name,email,about | |||
| Response | |||
|
List of all attendees (for a particular session) on the attendance list, waitlist or both combined ("type"), exported as JSON, Excel XLS or text format ("format").
The text format outputs attendees as a comma separated list of items formatted as "Firstname Lastname <email@domain.com>", ideal for copy/pasting into an e-mail client To: field. If Check-in is used attendance list will contain date/time when an attendee has checked in. Does not support field customization. | |||
| Note: using the text format will only export users with an e-mail. | |||
SESSION: COUNT
No. of sessions since a date.
https://your_conference.sched.com/api/session/count
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| since | No | Retrieve sessions modified since timestamp (Unix epoch time) | 40 |
| status | No | Set to "del" to get count of deleted sessions | 40 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/session/count?api_key=secret&since=1282755813&status=del | |||
| Response | |||
| Total number of sessions. | |||
USER: LIST
List of users.
https://your_conference.sched.com/api/user/list
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| format | No | One of "csv", "xml", "json". Defaults to "csv" | 4 |
| fields | No | Comma separated list of fields. Default: "username", "name", "phone", "email", "joined", "lastactive", "avatar", "company", "position", "location". Available fields: "id", "username", "name", "phone", "email", "url", "about", "role", "joined", "lastactive", "avatar", "company", "position", "location"; | 512 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/user/list?api_key=secret&format=xml | |||
| Response CSV | |||
|
CSV exported file. | |||
| Response JSON | |||
[{
"username": "youruser1",
"name": "Your User 1",
"phone": "(555)5557897",
"email": "user@example.com",
"joined": "2011-04-14 20:55:52",
"lastactive": "2011-04-15 21:57:21",
"avatar": "https://url.to/image.jpg"
},{
"username": "youruser2",
"name": "Your User 2",
"phone": "(123)5557897",
"email": "user2@example.com",
"joined": "2012-02-14 20:55:52",
"lastactive": "2012-03-20 21:57:21",
"avatar": "https://example.com/user.jpg"
}]
| |||
| Response XML | |||
<users>
<user>
<username>youruser1</username>
<name>Your User 1</name>
<phone>(555)5557897</phone>
<email>user1@example.com</email>
<joined>2011-04-14 20:55:52</joined>
<lastactive>2011-04-15 21:57:21</lastactive>
<avatar>https://url.to/image.jpg</avatar>
</user>
<user>
<username>youruser2</username>
<name>Your User 2</name>
<phone>(123)5557897</phone>
<email>user2@example.com</email>
<joined>2012-02-14 20:55:52</joined>
<lastactive>2012-03-20 21:57:21</lastactive>
<avatar>https://example.com/user.jpg</avatar>
</user>
</users>
| |||
USER: ADD
Add a new user. Must provide either username or email. You do not need to provide both.
https://your_conference.sched.com/api/user/add
Note: if user with provided email exists on Sched (e.g. joined a past event), this method cannot be used. They can be found using user-get and then modified/given a role.
To add the user as an attendee use role-add. To modify user's profile use user-mod.
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| username | Yes (or email) | Allowed: alphanumerics, period, underscore | 40 |
| Yes (or username) | User's Email Address | 80 | |
| password | No | User's desired password. Optional. Random password will be generated if none provided. | 32 |
| phone | No | User's Phone Number (xxx-xxx-xxxx) | 40 |
| privacy | No | Default is 1 (on), Set to 0 (off) | 1 |
| role | No | One of the following: "attendee", "speaker", "artist", "sponsor", "exhibitor" | 10 |
| sessions | No | Comma separated string of session id's which the user will be connected to | 1024 |
| full_name | No | User's full name | 120 |
| about | No | Short bio/description. Some HTML allowed (a,b,br,i,em,strong) | 8192 |
| avatar | No | Publicly accessible, not shortened URL to gif, jpg or png image. Images are copied and resized on our server. | 1024 |
| location | No | User's physical location (city, country) | 1024 |
| company | No | User's employer | 1024 |
| position | No | User's employment position (e.g. Chief Technology Officer) | 1024 |
| booth | No | Exhibitor booth (applies only to users with the role set to "exhibitor") | 1024 |
| send_email | No | Default is 1 (on), Set to 0 (off). Whether to send e-mail with login credentials to user. | 1 |
| tags | No | A comma separated list of tags to add to the user | 1024 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/user/add?api_key=secret&username=desired_username&email=user@example.com | |||
| Response | |||
| JSON encoded username and password of newly created user account. | |||
| Note: Successfully calling this method will automatically clear all the sample (demo) data that new Sched sites are filled with on creation. | |||
USER: MODIFY
Edit an existing user. User's password is required if changing username.
https://your_conference.sched.com/api/user/mod
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| uid | No | User's unique ID | 40 |
| username | No | Username of the user to be modified | 40 |
| password | No | User's password Use if you want to modify user's password If changing username, password is required. | 40 |
| No | Modify e-mail | 80 | |
| phone | No | Change Phone Number (xxx-xxx-xxxx) | 40 |
| privacy | No | Default is 1 (on), Set to 0 (off). | 1 |
| role | No | Add role to user. See user/add for possible roles. | 10 |
| sessions | No | Sessions connected to user under his "role" If role is anything but "attendee", modifying user's connected sessions will overwrite existing connections. If role is "attendee", it will add specified sessions on top of existing ones. | 1024 |
| full_name | No | Change full name | 120 |
| about | No | Change bio/description. Some HTML allowed (a,b,br,i,em,strong) | 8192 |
| avatar | No | Change profile picture. Publicly accessible, not shortened URL to gif, jpg or png image. Images are copied and resized on our server. | 1024 |
| location | No | User's physical location (city, country) | 1024 |
| company | No | User's employer | 1024 |
| position | No | User's employment position (e.g. Chief Technology Officer) | 1024 |
| booth | No | Exhibitor booth (applies only to users with the role set to "exhibitor") | 1024 |
| tags | No | A comma separated list of tags to give the user any tags they had previously are removed. If provided but empty then all tags are removed. If not provided whatever tags the user currently has are left as is. | 1024 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/user/mod?api_key=secret&username=username&email=user@example.com | |||
| Response | |||
|
"Ok" on successful change. JSON object with basic user info in the case of username change. Error text on failed request. | |||
USER: GET
Lookup a user.
https://your_conference.sched.com/api/user/get
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| by | Yes | What to look up user by. Available are "username", "email", "name" or "id". | 40 |
| term | Yes | Username, e-mail or name of user being looked up. | 512 |
| fields | No | Available user profile fields. Use them if you want to get fields you want in order preferred. Default: "username", "name", "email", "about", "url", "avatar", "role" Options: "username", "name", "email", "about", "url", "avatar", "role", "company", "position", "location" | 512 |
| format | No | Format of response. Available are "csv", "xml" or "json". Default is "csv" | 40 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/user/get?api_key=secret&by=username&term=username&format=json | |||
| Response | |||
| User's profile data or API error on unsuccessful lookup. | |||
USER: ACTIVE
List of users and last active date.
https://your_conference.sched.com/api/user/active
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/user/active?api_key=secret | |||
| Response | |||
| List of all attendees with "username" and "lastactive" fields. Sent as CSV file. | |||
USER: AVATAR
Add an avatar/photo to a user.
https://your_conference.sched.com/api/user/avatar
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| username | Yes | Existing user username | 40 |
| avatar | Yes | Publicly accessible, not shortened URL to gif, jpg or png image. Images are copied and resized on our server. | 1024 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/user/avatar?api_key=secret&username=username&avatar=https://example.com/image.jpg | |||
| Response | |||
| "Ok" string upon successful avatar save, error message otherwise. | |||
USER: SESSIONS
List of attendees and sessions they selected.
https://your_conference.sched.com/api/user/sessions
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| format | No | Format of response. Available as "csv" or "json". Default is "csv" | — |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/user/sessions?api_key=secret | |||
| Response | |||
| List of all attendees and sessions they selected. | |||
AUTH: LOGIN
Login and get authorized to add/remove sessions. The session key from this call can be used on GOING: ADD, GOING: DEL & GOING: SCHEDULE.
https://your_conference.sched.com/api/auth/login
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| username | Yes | Username of user account | 40 |
| password | Yes | User password | 32 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/auth/login?api_key=secret&username=user_name&password=user_pw | |||
| Response | |||
| Valid session key to use with the GOING methods. | |||
TAG: ADD
Add a new tag to an event
https://your_conference.sched.com/api/tag/add
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| name | Yes | Must be a unique alpha-numeric string. E.g.: Teacher, Developer, Performer etc. | 32 |
| slug | No | Must be a unique alpha-numeric string. If not provided then a unique slug will be attempted to be made from the name E.g.: teacher, developer, performer etc. | 32 |
| metadata[key] | No | meta data you can associate with the tag e.g. metatdata[price]=12 metadata[color]=red | 32 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/tag/add?api_key=secret&name=Teacher&slug=teacher | |||
| Response | |||
|
Returns the tag that was added. {
"result": {
"id": 34,
"slug": "teacher",
"name": "Teacher",
"dateModified": "2018-10-08 16:06:06",
"metadata": {
"color": "red"
},
"objectCount": 0
},
"status": "OK",
"code": 0
}
| |||
TAG: MODIFY
Edit an existing tag.
https://your_conference.sched.com/api/tag/mod
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| id | Yes | The id of the tag to modify | — |
| name | No | Must be a unique alpha-numeric string. E.g.: Teacher, Developer, Performer etc. | 32 |
| slug | No | Must be a unique alpha-numeric string. If not provided the slug will be left unaltered even on a name change E.g.: teacher, developer, performer etc. | 32 |
| metadata[key] | No | meta data you can associate with the tag e.g. metatdata[price]=12 metadata[color]=red | 32 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/tag/people/mod?api_key=secret&id=32&name=Lecturer&id=34 | |||
| Response | |||
|
Returns the tag that was modified. {
"result": {
"id": 34,
"slug": "teacher",
"name": "Lecturer",
"dateModified": "2018-10-08 16:06:06",
"metadata": {
"color": "red"
},
"objectCount": 0
},
"status": "OK",
"code": 0
}
| |||
TAG: DELETE
Tag a session.
https://your_conference.sched.com/api/tag/del
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| id | Yes | The id of the tag to modify | — |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/tag/del?api_key=secret&id=34 | |||
| Response | |||
|
Returns the tag that was deleted. NOTE: the returned id will be null {
"result": {
"id": null,
"slug": "teacher",
"name": "Lecturer",
"dateModified": "2018-10-08 16:06:06",
"metadata": {
"color": "red"
},
"objectCount": 0
},
"status": "OK",
"code": 0
}
| |||
TAG: LIST
List of tags for event.
https://your_conference.sched.com/api/tag/get
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/tag/get?api_key=secret | |||
| Response | |||
List of all tags associated with the event in JSON.
{
"result": [
{
"id": "33",
"slug": "bang",
"name": "Bang",
"dateModified": "2018-10-08 01:00:30",
"metadata": null,
"objectCount": "101"
},
{
"id": "32",
"slug": "boom",
"name": "Boom",
"dateModified": "2018-10-08 01:00:28",
"metadata": null,
"objectCount": "101"
}
],
"status": "OK",
"code": 0
}
| |||
GOING: ADD
Add sessions to a user.
https://your_conference.sched.com/api/going/add
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| session | Yes | Authenticated user session key, obtained via AUTH: LOGIN | 40 |
| sessions | Yes | Comma separated string of session keys or session id's which user will attend | 32 |
| by | No | If using session id's for sessions parameter, you must set this to 'id' | |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/going/add?api_key=secret&session=valid_session_key&sessions=id1,id2,id3 | |||
| Response | |||
| Text string with message, for each session "Adding event:session_key (or id) to user:user_id" or "Couldn't find event:session_key (or id)", separated by newlines | |||
GOING: DEL
Remove sessions from a user.
https://your_conference.sched.com/api/going/del
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| session | Yes | Authenticated user session key, obtained via AUTH: LOGIN | 40 |
| sessions | Yes | Comma separated string of session keys or session id's which user will be removed from | 32 |
| by | No | If using session id's for sessions parameter, you must set this to 'id' | |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/going/del?api_key=secret&session=valid_session_key&sessions=id1,id2,id3 | |||
| Response | |||
| Text string with message, for each session "Removed event:session_key to user:user_id" or "Couldn't find event:session_key", separated by newlines | |||
GOING: SCHEDULE
User's schedule in HTML or json.
https://your_conference.sched.com/api/going/schedule
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| session | Yes | Authenticated user session key, obtained via /api/auth/login | 40 |
| username | No | Optional username to look up other public user's profiles | 40 |
| format | No | html (default) or json | |
| ignore_in_session | No | if n (default) it will return only events for user that are upcoming, y returns all (past and upcoming) | |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/going/schedule?api_key=secret&session=valid_session_key | |||
| Response | |||
| HTML formatted or json of user's schedule. | |||
GOING: LIST
Single user's schedule.
https://your_conference.sched.com/api/going/list
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| session | Yes | Authenticated user session key, obtained via /api/auth/login | 40 |
| username | Yes | Username for which to get attended sessions | 40 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/going/list?api_key=secret&session=valid_session_key&username=user_to_get_sessions_for | |||
| Response | |||
| Exported list of user's sessions. Sent as JSON. | |||
GOING: ALL
All users' schedules.
https://your_conference.sched.com/api/going/all
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/going/all?api_key=secret | |||
| Response | |||
| Exported list of all attendees. Sent as JSON. | |||
ASSETS: BANNER
Mobile header image.
https://your_conference.sched.com/api/assets/banner
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| modify_date | No | Unix Timestamp formatted last update | 40 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/assets/banner?api_key=secret&modify_date=0 | |||
| Response | |||
| Base 64 encoded image. | |||
ROLE: ADD
Assign a role to a user.
https://your_conference.sched.com/api/role/add
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| username | Yes | Username of user which is to be assigned a role | 40 |
| role | Yes | One of the following: "attendee", "speaker", "artist", "sponsor", "exhibitor" | 10 |
| sessions | No | Comma separated string of session keys which the user will be associated with | 1024 |
| send_email | No | Default is 1 (on), Set to 0 (off). Whether to send e-mail with login credentials to user if not previously invited | 1 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/role/add?api_key=secret&username=user_name&sessions=key1,key2,key3 | |||
| Response | |||
| API error in case of the invalid request, "Ok" for successful action. | |||
ROLE: DEL
Remove a role from a user.
https://your_conference.sched.com/api/role/del
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| username | Yes | Username of user which is to be removed a role | 40 |
| role | Yes | One of the following: "attendee", "speaker", "artist", "sponsor", "exhibitor" | 10 |
| sessions | No | Comma separated string of session id's which the user will be disconnected from If no sessions provided, the user will be disconnected from all sessions associated with given role. | 1024 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/role/del?api_key=secret&username=user_name&sessions=id1,id2,id3 | |||
| Response | |||
| API error in case of the invalid request, "Ok" for successful action. | |||
ROLE: EXPORT
Export users in a specific role. Useful for printed materials.
https://your_conference.sched.com/api/role/export
| Field | Required | Description | Max Length |
|---|---|---|---|
| api_key | Yes | Provided to you by us | 32 |
| role | Yes | One of the following: "attendee", "speaker", "artist", "sponsor", "exhibitor" | 10 |
| format | No | One of the following: "csv", "json", "csv", "xls". Default is "csv" | 4 |
| strip_html | No | Remove HTML tags from description | 1 |
| featured | No | Set to "y" to export just the featured users (valid for all roles except "attendee") | 1 |
| fields | No | Comma separated string of fields desired.
Default: "name", "email", "company", "position", "location", "about", "url", "avatar", "tags" Default for exhibitor: "name", "email", "booth", "about", "url", "avatar" Available: "id", "username", "name", "email", "phone", "about", "avatar", "sessions", "location", "booth" (exhibitor-only), "company", "position", "privacy_mode", "lastactive" (in PST) If you add sessions to "fields" parameter list, titles of sessions attached to role will be added to the output. | 1024 |
| Example GET Usage (all on one line) | |||
| https://your_conference.sched.com/api/role/export?api_key=secret&role=speaker&format=xml&strip_html=Y | |||
| Response | |||
| API error in case of the invalid request, JSON/XML data or CSV file, depending on format parameter. | |||
| Remarks | |||
| |||