API Documentation

The API is an interface for accessing information contained in your Flowbooking account. You can access this information for building custom components, or integrating Flowbooking with internal systems.

For example, you could use the API to:

The API responds to HTTP GET requests and returns JSON[?] or JSONP[?] in UTF-8 encoding. The API supports cross-origin requests using CORS[?]. Errors are signalled using the HTTP response code 400 (Bad Request).

Access to the API is not restricted, but its use falls under the Terms of Service and the Acceptable Use Policy.

Events API

The following examples use the account name demo. You should substitute demo with your own account name.

The events API is a simple read-only API for accessing events. It returns a list of up to 100 events using the last hour as the start date. E.g. if it is 10:59, it will show events from 10:00 onwards.

It returns an event ID, the name of the event, the date in UNIX time format (milliseconds since epoch), the event description (truncated by default), and location information (ID and name). It only returns visible events.

The events API will never return more than 100 events, but you can limit the number of events to a smaller number using the limit parameter. The following example will return two events at most.

Event descriptions may contain text or HTML. By default, the events API will return event descriptions with all HTML stripped (plain text) and truncate them to 40 characters to reduce bandwidth use. To get the full plain text description, set the description parameter to full.

To get the full HTML description, set the description parameter to html. The HTML description is always transmitted in its entirety.

The events API supports JSON with Padding for applications which require it. JSONP is typically used for fetching information using JavaScript across domains where CORS is not an option. You can enable JSONP by specifying a function name to use as padding with the jsonp parameter. Valid paddings are composed of ASCII alphanumeric characters, underscore '_', dollar sign '$' or period '.'; start with a letter, underscore or dollar sign; are no longer than 128 characters; and are not reserved words in the ECMAScript language.