Sched API

https://sched.com/api
Admin
The Sched API provides a RESTful interface for programmatic management of event information,...
Tokens:9,444
Snippets:25
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Sched API: Get User Schedule

Source: https://sched.com/api/index

Retrieves a user's schedule in HTML or JSON format. Requires API key and session key. Optionally accepts a username to view public profiles or parameters to filter by format and include past events.

```APIDOC
GOING: SCHEDULE
User's schedule in HTML or json.
https://your_conference.sched.com/api/going/schedule

Parameters:
- api_key (Yes, 32): Provided to you by Sched.
- session (Yes, 40): Authenticated user session key, obtained via /api/auth/login.
- username (No, 40): Optional username to look up other public user's profiles.
- format (No): 'html' (default) or 'json'.
- ignore_in_session (No): 'n' (default) returns only upcoming events, 'y' returns all (past and upcoming).

Example GET Usage:
https://your_conference.sched.com/api/going/schedule?api_key=secret&session=valid_session_key

Response:
HTML formatted or json of user's schedule.
```

--------------------------------

### Sched API: Get Banner Asset

Source: https://sched.com/api/index

Retrieves the mobile header image (banner) for the conference. Requires an API key and optionally accepts a modify_date timestamp to fetch updates.

```APIDOC
ASSETS: BANNER
Mobile header image.
https://your_conference.sched.com/api/assets/banner

Parameters:
- api_key (Yes, 32): Provided to you by Sched.
- modify_date (No, 40): Unix Timestamp formatted last update.

Example GET Usage:
https://your_conference.sched.com/api/assets/banner?api_key=secret&modify_date=0

Response:
Base 64 encoded image.
```

--------------------------------

### Sched API: Add User

Source: https://sched.com/api/index

Adds a new user to the Sched platform. Requires either a username or email. Provides options for setting user details like role, password, and contact information.

```APIDOC
Endpoint: /api/user/add
Method: GET

Description:
Adds a new user to the Sched conference. At least one of 'username' or 'email' must be provided. If a user with the specified email already exists, this method cannot be used; use USER-GET to find them and then USER-MOD or ROLE-ADD.

Parameters:
- api_key (string, Required): Your unique API key provided by Sched.
- username (string, Required if email not provided): Desired username for the user. Allowed characters: alphanumerics, period, underscore. Max Length: 40.
- email (string, Required if username not provided): User's email address. Max Length: 80.
- password (string, Optional): User's desired password. If not provided, a random password will be generated. Max Length: 32.
- phone (string, Optional): User's phone number. Format: xxx-xxx-xxxx. Max Length: 40.
- privacy (integer, Optional): Controls user privacy settings. Defaults to 1 (on). Set to 0 (off) to disable.
- role (string, Optional): Assigns a role to the user. Accepted values: 'attendee', 'speaker', 'artist', 'sponsor', 'exhibitor'. Max Length: 10.
- sessions (string, Optional): A comma-separated list of session IDs to associate the user with. Max Length: 1024.
- full_name (string, Optional): The user's full name. Max Length: 120.
- about (string, Optional): A short biography or description for the user. Limited HTML tags allowed (a,b,br,i,em,strong). Max Length: 8192.
- avatar (string, Optional): A publicly accessible URL to the user's avatar image (gif, jpg, or png). Images are copied and resized. Max Length: 1024.
- location (string, Optional): The user's physical location (e.g., city, country). Max Length: 1024.
- company (string, Optional): The user's employer. Max Length: 1024.
- position (string, Optional): The user's job title or position. Max Length: 1024.
- booth (string, Optional): The exhibitor booth number (only applicable if role is 'exhibitor'). Max Length: 1024.
- send_email (integer, Optional): Determines if an email with login credentials should be sent to the user. Defaults to 1 (on). Set to 0 (off) to prevent sending.
- tags (string, Optional): A comma-separated list of tags to assign to the user. Max Length: 1024.

Example Usage:
https://your_conference.sched.com/api/user/add?api_key=secret&username=desired_username&email=user@example.com

Response:
Returns a JSON object containing the username and password of the newly created user account. Successfully calling this method also clears any sample (demo) data present on new Sched sites.

Related Methods:
- USER: LIST: To retrieve a list of existing users.
- USER: MOD: To modify an existing user's profile.
- ROLE: ADD: To add a user to a specific role (e.g., attendee).
```

--------------------------------

### Site: Sync API

Source: https://sched.com/api/index

Retrieves basic event information including dates, venues, types, and CSS. Requires an API key and optionally accepts a modify_date timestamp for incremental updates. Returns JSON encoded site wording and CSS.

```APIDOC
SITE: SYNC

Description: View basic event info (dates, venues, types, css)
URL: https://your_conference.sched.com/api/site/sync

Parameters:
- api_key: Yes, Provided to you by us (Max Length: 32)
- modify_date: No, Last sync timestamp. Format: Unix timestamp (Max Length: 20)

Example GET Usage:
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":  {},
"venues": {},
"types":  {},
"style":  ""
}
```

--------------------------------

### Sched API: List All Users' Schedules

Source: https://sched.com/api/index

Retrieves a list of all users' schedules. Requires only an API key. The response is exported as JSON.

```APIDOC
GOING: ALL
All users' schedules.
https://your_conference.sched.com/api/going/all

Parameters:
- api_key (Yes, 32): Provided to you by Sched.

Example GET Usage:
https://your_conference.sched.com/api/going/all?api_key=secret

Response:
Exported list of all attendees. Sent as JSON.
```

--------------------------------

### Add Session API Endpoint

Source: https://sched.com/api/index

Adds a new session to the Sched platform. Requires an API key and session key for authentication and identification. All required fields must be provided for successful session creation. Custom fields can also be added.

```APIDOC
Endpoint: /api/session/add
Method: GET

Parameters:
  api_key (string, required): Provided by Sched. Max Length: 32.
  session_key (string, required): Unique alpha-numeric string for the session. Max Length: 32.
  name (string, required): Name of the session. Max Length: 120.
  session_start (string, required): Full date + time for session start. Format: YYYY-MM-DD HH:MM. Max Length: 40.
  session_end (string, required): Full date + time for session end. Format: YYYY-MM-DD HH:MM. Max Length: 40.
  session_type (string, required): Used to filter sessions. Max Length: 32.
  session_subtype (string, optional): For additional filter/organizing. Max Length: 32.
  description (string, optional): Detailed description. Links (HTML Tag <a>) allowed. Max Length: 8kb.
  media_url (string, optional): URL for media (audio/video/documents). Must use HTTPS. Max Length: 250.
  venue (string, optional): Building name / Company name. Max Length: 80.
  address (string, optional): Room # / Street Address. Max Length: 250.
  tags (string, optional): Comma-separated words and phrases. Max Length: 250.
  seats (string, optional): Venue capacity. Max Length: 250.
  rsvp_url (string, optional): URL for Custom Button. Max Length: 1024.
  ticket_message (string, optional): Custom ticket upgrade message (accepts basic HTML). Max Length: 1024.
  active (string, optional): 'Y' for active, 'N' for deactivated. Max Length: 1.
  (custom fields) (any, optional): Add custom named fields and their values.

Example Usage:
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

Notes:
Using this method automatically clears any sample/demo data pre-filled on new Sched sites.
```

--------------------------------

### Sched API: List Users

Source: https://sched.com/api/index

Retrieves a list of users from the Sched platform. Supports filtering and output formatting via query parameters. Responses can be in CSV, JSON, or XML format.

```APIDOC
Endpoint: /api/user/list
Method: GET

Description:
Lists users associated with a Sched conference. Allows specifying output format and desired fields.

Parameters:
- api_key (string, Required): Your unique API key provided by Sched.
- format (string, Optional): Specifies the output format. Accepts 'csv', 'xml', or 'json'. Defaults to 'csv'. Max Length: 4.
- fields (string, Optional): A comma-separated list of fields to include in the response. Defaults to 'username,name,phone,email,joined,lastactive,avatar,company,position,location'. Available fields include 'id', 'username', 'name', 'phone', 'email', 'url', 'about', 'role', 'joined', 'lastactive', 'avatar', 'company', 'position', 'location'. Max Length: 512.

Example Usage:
https://your_conference.sched.com/api/user/list?api_key=secret&format=xml

Responses:
- CSV: Comma-separated values representing user data.
- JSON: An array of user objects.
- XML: An XML structure containing user data.

Related Methods:
- USER: ADD: For adding new users.
- USER: GET: For retrieving details of a specific user.
```

```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"
}]
```

```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>
```

--------------------------------

### Sched API: Add Sessions to User

Source: https://sched.com/api/index

Adds specified sessions to a user's schedule. Requires API key and session key. Sessions can be identified by key or ID, with an optional 'by' parameter to specify ID usage.

```APIDOC
GOING: ADD
Add sessions to a user.
https://your_conference.sched.com/api/going/add

Parameters:
- api_key (Yes, 32): Provided to you by Sched.
- session (Yes, 40): Authenticated user session key, obtained via /api/auth/login.
- sessions (Yes, 32): Comma separated string of session keys or session ids which user will attend.
- by (No): If using session id's for sessions parameter, you must set this to 'id'.

Example GET Usage:
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.
```

--------------------------------

### Sched API: Authentication and Tag Management

Source: https://sched.com/api/index

This section covers the Sched API endpoints for user authentication and managing event tags. The authentication endpoint provides a session key for subsequent operations. Tag management includes adding new tags, modifying existing ones, deleting tags, and listing all tags associated with an event.

```APIDOC
AUTH: LOGIN
  Description: Login and get authorized to add/remove sessions. The session key from this call can be used on GOING: ADD, GOING: DEL & GOING: SCHEDULE.
  URL: https://your_conference.sched.com/api/auth/login
  Method: GET
  Parameters:
    api_key (string, required): Provided to you by Sched. Max Length: 32.
    username (string, required): Username of user account. Max Length: 40.
    password (string, required): User password. Max Length: 32.
  Example Usage:
    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
  Description: Add a new tag to an event.
  URL: https://your_conference.sched.com/api/tag/add
  Method: GET
  Parameters:
    api_key (string, required): Provided to you by Sched. Max Length: 32.
    name (string, required): Must be a unique alpha-numeric string (e.g., Teacher, Developer, Performer). Max Length: 32.
    slug (string, optional): Must be a unique alpha-numeric string. If not provided, a unique slug will be attempted from the name. Max Length: 32.
    metadata[_key_] (string, optional): Meta data you can associate with the tag (e.g., metadata[price]=12, metadata[color]=red). Max Length: 32.
  Example Usage:
    https://your_conference.sched.com/api/tag/add?api_key=secret&name=Teacher&slug=teacher
  Response:
    Returns the tag that was added.
    Example:
    {
        "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
  Description: Edit an existing tag.
  URL: https://your_conference.sched.com/api/tag/mod
  Method: GET
  Parameters:
    api_key (string, required): Provided to you by Sched. Max Length: 32.
    id (integer, required): The id of the tag to modify.
    name (string, optional): Must be a unique alpha-numeric string (e.g., Teacher, Developer, Performer). Max Length: 32.
    slug (string, optional): Must be a unique alpha-numeric string. If not provided, the slug will be left unaltered even on a name change. Max Length: 32.
    metadata[_key_] (string, optional): Meta data you can associate with the tag (e.g., metadata[price]=12, metadata[color]=red). Max Length: 32.
  Example Usage:
    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.
    Example:
    {
        "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
  Description: Tag a session (this description seems incorrect, it should be 'Delete a tag').
  URL: https://your_conference.sched.com/api/tag/del
  Method: GET
  Parameters:
    api_key (string, required): Provided to you by Sched. Max Length: 32.
    id (integer, required): The id of the tag to modify.
  Example Usage:
    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.
    Example:
    {
        "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
  Description: List of tags for event.
  URL: https://your_conference.sched.com/api/tag/get
  Method: GET
  Parameters:
    api_key (string, required): Provided to you by Sched. Max Length: 32.
  Example Usage:
    https://your_conference.sched.com/api/tag/get?api_key=secret
  Response:
    List of all tags associated with the event in JSON.
    Example:
    {
      "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
    }

```

--------------------------------

### Sched API: List User's Sessions

Source: https://sched.com/api/index

Retrieves a single user's schedule, listing all sessions they are attending. Requires API key, session key, and the target username.

```APIDOC
GOING: LIST
Single user's schedule.
https://your_conference.sched.com/api/going/list

Parameters:
- api_key (Yes, 32): Provided to you by Sched.
- session (Yes, 40): Authenticated user session key, obtained via /api/auth/login.
- username (Yes, 40): Username for which to get attended sessions.

Example GET Usage:
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.
```

--------------------------------

### Sched API Add User Avatar

Source: https://sched.com/api/index

Adds or updates a user's avatar by providing a publicly accessible URL to an image. The image will be processed and resized by the server.

```APIDOC
USER: AVATAR
Endpoint: /api/user/avatar
Method: GET (as per example)

Description:
Associates a profile picture with a user account. The image must be hosted publicly.

Parameters:
- api_key (Yes, 32 chars): Your unique API key.
- username (Yes, 40 chars): The username of the existing user to whom the avatar will be added.
- avatar (Yes, 1024 chars): A publicly accessible, non-shortened URL pointing to a GIF, JPG, or PNG image. The image will be copied and resized on the server.

Example GET Usage:
https://your_conference.sched.com/api/user/avatar?api_key=secret&username=username&avatar=https://example.com/image.jpg

Response:
- "Ok" string upon successful saving of the avatar.
- An error message if the operation fails.
```

--------------------------------

### Sched API List User Sessions

Source: https://sched.com/api/index

Retrieves a list of attendees and the sessions they have selected. The response format can be specified as CSV or JSON.

```APIDOC
USER: SESSIONS
Endpoint: /api/user/sessions
Method: GET (as per example)

Description:
Provides a list of all attendees and the sessions they have registered for or selected.

Parameters:
- api_key (Yes, 32 chars): Your unique API key.
- format (No): The desired format for the response. Available options: "csv" or "json". Default is "csv".

Example GET Usage:
https://your_conference.sched.com/api/user/sessions?api_key=secret

Response:
A list of all attendees and their selected sessions, formatted as either CSV or JSON based on the 'format' parameter.
```

--------------------------------

### Sched API User Lookup

Source: https://sched.com/api/index

Retrieves user profile information based on specified lookup criteria. Supports searching by username, email, name, or ID.

```APIDOC
USER: GET
Endpoint: /api/user/get
Method: GET (as per example)

Description:
Looks up a user's profile data. You can specify which fields to retrieve and the response format.

Parameters:
- api_key (Yes, 32 chars): Your unique API key.
- by (Yes, 40 chars): The field to use for lookup. Available options: "username", "email", "name", or "id".
- term (Yes, 512 chars): The value to search for (e.g., the username, email, or name).
- fields (No, 512 chars): Comma-separated list of desired user profile fields. Default order: "username", "name", "email", "about", "url", "avatar", "role". Available options: "username", "name", "email", "about", "url", "avatar", "role", "company", "position", "location".
- format (No, 40 chars): The desired response format. Available options: "csv", "xml", or "json". Default is "csv".

Example GET Usage:
https://your_conference.sched.com/api/user/get?api_key=secret&by=username&term=username&format=json

Response:
- User's profile data in the specified format, or an API error message on unsuccessful lookup.
```

--------------------------------

### Sched API: Session Export Endpoint

Source: https://sched.com/api/index

Exports session data with HTML stripped, suitable for printed materials or system imports. Supports various output formats (CSV, XML, JSON, XLS) and allows specifying fields, pagination, and HTML stripping.

```APIDOC
Endpoint: /api/session/export

Description: Lists sessions with HTML stripped for easier integration.

Parameters:
  - api_key (Yes, 32): Provided by Sched.
  - since (No, 4): Unix epoch time to retrieve sessions modified since.
  - format (No, 40): Output format. One of "csv", "xml", "json", "xls". Defaults to "csv".
  - fields (No, 1024): Comma-separated list of fields to include and their order. Leave blank for all fields.
  - page (No, 8): Page number for paginated results.
  - limit (No, 8): Number of sessions per page. Defaults to 1000.
  - strip_html (No, 1): Set to "Y" to remove HTML tags from descriptions.
  - custom_data (No, 1): Include with value "Y" to add custom fields. Spaces in field names are replaced by underscores.

Example GET Usage:
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.
```

--------------------------------

### Sched API: Role Export

Source: https://sched.com/api/index

Exports users belonging to a specific role, suitable for printed materials or data analysis. Supports various output formats and allows customization of exported fields.

```APIDOC
Endpoint: /api/role/export
Method: GET

Description:
  Exports users in a specific role.

Parameters:
  - api_key (string, required): Provided by Sched.
  - role (string, required): The role to export users from. Accepted values: "attendee", "speaker", "artist", "sponsor", "exhibitor". Max length: 10.
  - format (string, optional): The desired output format. Accepted values: "csv", "json", "xls". Defaults to "csv". Max length: 4.
  - strip_html (string, optional): Set to "y" to remove HTML tags from descriptions. Max length: 1.
  - featured (string, optional): Set to "y" to export only featured users. Valid for all roles except "attendee". Max length: 1.
  - fields (string, optional): A comma-separated string of fields to include in the export. Max length: 1024.
    Default fields: "name", "email", "company", "position", "location", "about", "url", "avatar", "tags".
    Default for exhibitor: "name", "email", "booth", "about", "url", "avatar".
    Available fields: "id", "username", "name", "email", "phone", "about", "avatar", "sessions", "location", "booth" (exhibitor-only), "company", "position", "privacy_mode", "lastactive" (in PST).
    If "sessions" is included, session titles are added to the output.

Example Usage:
  https://your_conference.sched.com/api/role/export?api_key=secret&role=speaker&format=xml&strip_html=Y

Response:
  - API error: In case of an invalid request.
  - JSON/XML data or CSV file: Depending on the format parameter.

Remarks:
  - "xls" format does not support field customization; default fields are always returned.
  - If the "sessions" field is specified:
    - "json" format: Contains an array of session IDs per row.
    - "xml" format: Contains an array of session names per row.
    - "csv" format: Contains one row per session name.
```

--------------------------------

### Sched API: Assign Role to User

Source: https://sched.com/api/index

Assigns a role to a user, optionally associating them with specific sessions. Supports roles like 'attendee', 'speaker', etc. Can control email notifications for new users.

```APIDOC
ROLE: ADD
Assign a role to a user.
https://your_conference.sched.com/api/role/add

Parameters:
- api_key (Yes, 32): Provided to you by Sched.
- username (Yes, 40): Username of user to assign a role.
- role (Yes, 10): One of: "attendee", "speaker", "artist", "sponsor", "exhibitor".
- sessions (No, 1024): Comma separated string of session keys for association.
- send_email (No, 1): Default is 1 (on). Set to 0 (off) to disable email notifications for new users.

Example GET Usage:
https://your_conference.sched.com/api/role/add?api_key=secret&username=user_name&sessions=key1,key2,key3

Response:
API error in case of invalid request, "Ok" for successful action.
```

--------------------------------

### Sched API: Session Seats Endpoint

Source: https://sched.com/api/index

Retrieves attendance lists and waitlists for specific sessions. Supports filtering by type (attendance, waitlist, all) and output format (JSON, XLS, text). The text format is optimized for email clients.

```APIDOC
Endpoint: /api/session/seats

Description: Provides attendance lists and waitlists for sessions.

Parameters:
  - api_key (Yes, 32): Provided by Sched.
  - id OR key (Yes, 32): Unique session ID or session key.
  - type (No, 40): List type. One of "attendance", "waitlist", or "all". Defaults to "attendance".
  - format (No, 40): Output format. One of "json", "xls", or "text". Defaults to "csv".

Example GET Usage:
https://your_conference.sched.com/api/session/seats?api_key=secret&type=waitlist&format=json&fields=name,email,about

Response:
List of attendees for a session, exported in the specified format. Text format outputs attendees as "Firstname Lastname <email@domain.com>" and only includes users with an email. Does not support field customization.
```

--------------------------------

### Sched API List Active Users

Source: https://sched.com/api/index

Retrieves a list of all attendees along with their last active date. The response is provided as a CSV file.

```APIDOC
USER: ACTIVE
Endpoint: /api/user/active
Method: GET (as per example)

Description:
Returns a list of all attendees and their last active timestamp.

Parameters:
- api_key (Yes, 32 chars): Your unique API key.

Example GET Usage:
https://your_conference.sched.com/api/user/active?api_key=secret

Response:
A CSV file containing "username" and "lastactive" fields for all attendees.
```

--------------------------------

### Sched API User Modification

Source: https://sched.com/api/index

Allows editing of existing user profiles. The user's password is required if the username is being changed. Various fields like email, phone, role, sessions, and profile details can be updated.

```APIDOC
USER: MODIFY
Endpoint: /api/user/mod
Method: GET (as per example)

Description:
Edits an existing user's profile information. Password is mandatory if the username is being modified.

Parameters:
- api_key (Yes, 32 chars): Your unique API key.
- uid (No, 40 chars): The user's unique identifier.
- username (No, 40 chars): The username of the user to modify.
- password (No, 40 chars): The user's password. Required if changing the username.
- email (No, 80 chars): Updates the user's email address.
- phone (No, 40 chars): Updates the user's phone number (format: xxx-xxx-xxxx).
- privacy (No, 1 char): Sets privacy status. Default is 1 (on), 0 for off.
- role (No, 10 chars): Assigns a role to the user. Refer to user/add for possible roles.
- sessions (No, 1024 chars): Modifies sessions connected to the user. If role is not 'attendee', existing connections are overwritten. If role is 'attendee', sessions are added to existing ones.
- full_name (No, 120 chars): Updates the user's full name.
- about (No, 8192 chars): Updates the user's bio/description. Allows limited HTML (a,b,br,i,em,strong).
- avatar (No, 1024 chars): Updates the user's profile picture URL. Must be a publicly accessible GIF, JPG, or PNG. Images are processed and resized server-side.
- location (No, 1024 chars): Updates the user's physical location (city, country).
- company (No, 1024 chars): Updates the user's employer.
- position (No, 1024 chars): Updates the user's job title.
- booth (No, 1024 chars): Assigns an exhibitor booth (only applicable for users with the 'exhibitor' role).
- tags (No, 1024 chars): A comma-separated list of tags. Previous tags are removed. If provided and empty, all tags are removed. If not provided, existing tags remain unchanged.

Example GET Usage:
https://your_conference.sched.com/api/user/mod?api_key=secret&username=username&email=user@example.com

Response:
- "Ok" on successful modification.
- JSON object with basic user info if username was changed.
- Error text on failed requests.
```

--------------------------------

### Sched API: Remove Sessions from User

Source: https://sched.com/api/index

Removes specified sessions from a user's schedule. Requires API key and session key. Sessions can be identified by key or ID, with an optional 'by' parameter to specify ID usage.

```APIDOC
GOING: DEL
Remove sessions from a user.
https://your_conference.sched.com/api/going/del

Parameters:
- api_key (Yes, 32): Provided to you by Sched.
- session (Yes, 40): Authenticated user session key, obtained via /api/auth/login.
- sessions (Yes, 32): Comma separated string of session keys or session id's which user will be removed from.
- by (No): If using session id's for sessions parameter, you must set this to 'id'.

Example GET Usage:
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.
```

--------------------------------

### Sched API: Session List Endpoint

Source: https://sched.com/api/index

Retrieves a list of sessions from the Sched API. Supports filtering by modification timestamp, output format (CSV or JSON), and status (including deleted sessions). Custom data fields can also be included.

```APIDOC
Endpoint: /api/session/list

Description: Lists all conference sessions.

Parameters:
  - api_key (Yes, 32): Provided by Sched.
  - since (No, 4): Unix epoch time to retrieve sessions modified since.
  - format (No, 40): Output format. Leave blank for CSV or set to "json".
  - status (No, 40): Set to "del" to fetch only references to deleted sessions.
  - custom_data (No, 1): Include with value "Y" to add custom fields. Spaces in field names are replaced by underscores.

Example GET Usage:
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.
```

--------------------------------

### Sched API: Role Delete

Source: https://sched.com/api/index

Removes a specified role from a user. If no sessions are provided, the user is disconnected from all sessions associated with that role. Otherwise, the user is disconnected only from the specified sessions.

```APIDOC
Endpoint: /api/role/del
Method: GET

Description:
  Removes a role from a user.

Parameters:
  - api_key (string, required): Provided by Sched.
  - username (string, required): The username of the user from whom the role is to be removed. Max length: 40.
  - role (string, required): The role to remove. Accepted values: "attendee", "speaker", "artist", "sponsor", "exhibitor". Max length: 10.
  - sessions (string, optional): A comma-separated string of session IDs from which the user will be disconnected. Max length: 1024.
    If not provided, the user is disconnected from all sessions associated with the given role.

Example Usage:
  https://your_conference.sched.com/api/role/del?api_key=secret&username=user_name&sessions=id1,id2,id3

Response:
  - "Ok": For successful action.
  - API error: In case of an invalid request.
```

--------------------------------

### Modify Session API Endpoint

Source: https://sched.com/api/index

Edits an existing session identified by its session key. Allows updating various session details like name, time, description, and venue. Not all fields are required for modification.

```APIDOC
Endpoint: /api/session/mod
Method: GET

Parameters:
  api_key (string, required): Provided by Sched. Max Length: 32.
  session_key (string, required): Unique alpha-numeric string for the session. Max Length: 32.
  name (string, optional): Name of the session. Max Length: 120.
  session_start (string, optional): Full date + time for session start. Format: YYYY-MM-DD HH:MM. Max Length: 40.
  session_end (string, optional): Full date + time for session end. Format: YYYY-MM-DD HH:MM. Max Length: 40.
  session_type (string, optional): Used to filter sessions. Max Length: 32.
  session_subtype (string, optional): For additional filter/organizing. Max Length: 32.
  description (string, optional): Detailed description. Links (HTML Tag <a>) allowed. Max Length: 8kb.
  media_url (string, optional): URL for media (audio/video/documents). Must use HTTPS. Max Length: 250.
  venue (string, optional): Building name / Company name. Max Length: 80.
  address (string, optional): Room # / Street Address. Max Length: 250.
  tags (string, optional): Comma-separated words and phrases. Max Length: 250.
  seats (string, optional): Venue capacity. Max Length: 250.
  rsvp_url (string, optional): URL for Custom Button. Max Length: 1024.
  ticket_message (string, optional): Custom ticket upgrade message (accepts basic HTML). Max Length: 1024.
  active (string, optional): 'Y' for active, 'N' for deactivated. Max Length: 1.

Example Usage:
https://your_conference.sched.com/api/session/mod?api_key=secret&session_key=kn1&venue=Main+Auditorium
```

--------------------------------

### Sched API: Session Count Endpoint

Source: https://sched.com/api/index

Retrieves the total count of sessions. Supports filtering by modification timestamp and status (e.g., deleted sessions).

```APIDOC
Endpoint: /api/session/count

Description: Returns the number of sessions.

Parameters:
  - api_key (Yes, 32): Provided by Sched.
  - since (No, 40): Unix epoch time to count sessions modified since.
  - status (No, 40): Set to "del" to get the count of deleted sessions.

Example GET Usage:
https://your_conference.sched.com/api/session/count?api_key=secret&since=1282755813&status=del

Response:
Total number of sessions matching the criteria.
```

--------------------------------

### Delete Session API Endpoint

Source: https://sched.com/api/index

Deactivates and hides a session from the public schedule. This method does not permanently delete data but marks the session as cancelled, maintaining data integrity. Requires API key and session key.

```APIDOC
Endpoint: /api/session/del
Method: GET

Parameters:
  api_key (string, required): Provided by Sched. Max Length: 32.
  session_key (string, required): Unique alpha-numeric string for the session. Max Length: 32.

Example Usage:
https://your_conference.sched.com/api/session/del?api_key=secret&session_key=kn1

Notes:
This API only deactivates a session and hides it from the public schedule. Existing links to this session will display "[CANCELLED]" while maintaining data integrity.
```
Tokens:
Raw