Events

GET
/sites/site-id/events

Get all events on a site.

Query parameters

count Set the number of events to return per response
offset Skip this many events from the start
category Return only events with this category (ex. ?category=Trade%20Fair)
theme Return only events with this theme (ex. ?theme=Business%20Growth)
date Return events that are ongoing on the specified day or during the specified month (ex. ?date=2016-12-25 or ?date=2016-01)
GET https://api.flockler.com/v1/sites/609/events
{
  "meta": {
    "count": 2
  },
  "events": [
    {
      "all_day": true,
      "description": null,
      "end_date": "2099-01-30T22:00:00Z",
      "free_admission": null,
      "id": 1039,
      "name": "Demo Event 2",
      "published_at": "2017-01-11T14:27:00Z",
      "registration_deadline": null,
      "signup": null,
      "site_id": 609,
      "start_date": "2017-01-29T22:00:00Z",
      "summary": "An event may also be quite lacking in information. Note that this event is an \"all-day\" event.",
      "tickets": null,
      "cover_url": null,
      "categories": [

      ],
      "languages": [

      ],
      "tags": [

      ],
      "themes": [

      ],
      "images": [

      ],
      "location": {
        "country_code": null,
        "id": 1039,
        "latitude": null,
        "locality": null,
        "longitude": null,
        "name": null,
        "phone": null,
        "postal_code": null,
        "street_address_primary": null,
        "street_address_secondary": null,
        "street_address_tertiary": null,
        "website": null
      },
      "organizer": {
        "id": 1041,
        "name": null
      }
    },
    {
      "all_day": false,
      "description": "<p>Flockler demo event.</p>\n\n<p>This text may include&nbsp;<strong>formatting</strong>&nbsp;of&nbsp;<em>all sorts</em>. Links:&nbsp;<a href=\"http://developers.flockler.com\" target=\"_blank\">http://developers.flockler.com</a>&nbsp;are also allowed.</p>\n",
      "end_date": "2099-01-29T14:19:00Z",
      "free_admission": false,
      "id": 1038,
      "name": "Demo Event",
      "published_at": "2017-01-11T14:19:12Z",
      "registration_deadline": "2017-01-20T06:00:00Z",
      "signup": "http://www.flockler.com",
      "site_id": 609,
      "start_date": "2017-01-21T14:19:00Z",
      "summary": "This is a demo event.\n\nIt's going to be long.",
      "tickets": "Normal tickets 15 000 EUR\nStudents 25 000 EUR\nChildren under 12 free",
      "cover_url": "https://flockler.com/thumbs/sites/609/hz1t643.jpg",
      "categories": [
        "Info Event"
      ],
      "languages": [
        "Finnish"
      ],
      "tags": [
        "hello",
        "world"
      ],
      "themes": [
        "Marketing and Communications"
      ],
      "images": [
        {
          "caption": "Demo pic",
          "id": 4601,
          "link": "http://www.flockler.com",
          "url": "https://flockler.com/thumbs/sites/609/hz1t643.jpg"
        }
      ],
      "location": {
        "country_code": "FI",
        "id": 1038,
        "latitude": "61.49601",
        "locality": "Tampere",
        "longitude": "23.772358",
        "name": "Flockler Headquarters",
        "phone": "1-800-FLOCKLER-RULES",
        "postal_code": "33100",
        "street_address_primary": "Rautatienkatu 26",
        "street_address_secondary": "Second Floor",
        "street_address_tertiary": null,
        "website": "http://www.flockler.com"
      },
      "organizer": {
        "id": 1040,
        "name": "Flockler"
      }
    }
  ]
}
Field Data type Description values
all_day boolean All day event? This means only the dates (not times) in start and end timestamps are meaningful. Time zones still need to be taken into consideration.
description string Long description of the event
end_date datetime End date. Take special care when 'all_day' is true.
free_admission boolean Free admission. The 'tickets' field may be empty if this is true.
id integer Unique ID of this event
name string Name of event
published_at datetime Event was published at this time. Only published events will be available via the API.
registration_deadline datetime Registration deadline for events that require registration. null if no deadline, or registration not required.
signup string URL to signup/registration if required. null if registration not required.
site_id integer Unique ID of the site this event belongs to
start_date datetime Start date. Take special care when 'all_day' is true.
summary string Short summary
tickets string Information on tickets
categories array of string The categories this event belongs in
languages array of string Main languages of the event
tags array of string Tags given to this event
themes array of string Themes of the event
images array of embedded image objects Images uploaded for the event. Includes the cover image, if one is present.
location embedded location object Details on the location (venue) of the event
organizer embedded organizer object Details on the organizer of the event
GET
/sites/site-id/events/event-id

Get information about an event.

Query parameters

fields Return only requested fields in the response (ex. ?fields=id,name)
GET https://api.flockler.com/v1/sites/609/events/1038
{
  "event": {
    "all_day": false,
    "description": "<p>Flockler demo event.</p>\n\n<p>This text may include&nbsp;<strong>formatting</strong>&nbsp;of&nbsp;<em>all sorts</em>. Links:&nbsp;<a href=\"http://developers.flockler.com\" target=\"_blank\">http://developers.flockler.com</a>&nbsp;are also allowed.</p>\n",
    "end_date": "2099-01-29T14:19:00Z",
    "free_admission": false,
    "id": 1038,
    "name": "Demo Event",
    "published_at": "2017-01-11T14:19:12Z",
    "registration_deadline": "2017-01-20T06:00:00Z",
    "signup": "http://www.flockler.com",
    "site_id": 609,
    "start_date": "2017-01-21T14:19:00Z",
    "summary": "This is a demo event.\n\nIt's going to be long.",
    "tickets": "Normal tickets 15 000 EUR\nStudents 25 000 EUR\nChildren under 12 free",
    "cover_url": "https://flockler.com/thumbs/sites/609/hz1t643.jpg",
    "categories": [
      "Info Event"
    ],
    "languages": [
      "Finnish"
    ],
    "tags": [
      "hello",
      "world"
    ],
    "themes": [
      "Marketing and Communications"
    ],
    "images": [
      {
        "caption": "Demo pic",
        "id": 4601,
        "link": "http://www.flockler.com",
        "url": "https://flockler.com/thumbs/sites/609/hz1t643.jpg"
      }
    ],
    "location": {
      "country_code": "FI",
      "id": 1038,
      "latitude": "61.49601",
      "locality": "Tampere",
      "longitude": "23.772358",
      "name": "Flockler Headquarters",
      "phone": "1-800-FLOCKLER-RULES",
      "postal_code": "33100",
      "street_address_primary": "Rautatienkatu 26",
      "street_address_secondary": "Second Floor",
      "street_address_tertiary": null,
      "website": "http://www.flockler.com"
    },
    "organizer": {
      "id": 1040,
      "name": "Flockler"
    }
  }
}
Field Data type Description values
all_day boolean All day event? This means only the dates (not times) in start and end timestamps are meaningful. Time zones still need to be taken into consideration.
description string Long description of the event
end_date datetime End date. Take special care when 'all_day' is true.
free_admission boolean Free admission. The 'tickets' field may be empty if this is true.
id integer Unique ID of this event
name string Name of event
published_at datetime Event was published at this time. Only published events will be available via the API.
registration_deadline datetime Registration deadline for events that require registration. null if no deadline, or registration not required.
signup string URL to signup/registration if required. null if registration not required.
site_id integer Unique ID of the site this event belongs to
start_date datetime Start date. Take special care when 'all_day' is true.
summary string Short summary
tickets string Information on tickets
categories array of string The categories this event belongs in
languages array of string Main languages of the event
tags array of string Tags given to this event
themes array of string Themes of the event
images array of embedded image objects Images uploaded for the event. Includes the cover image, if one is present.
location embedded location object Details on the location (venue) of the event
organizer embedded organizer object Details on the organizer of the event

Event images

Field Data type Description values
caption string Caption for image
id integer Unique identifier of this image
link string URL, for when the image acts as a link to somewhere else
url string URL of the image file itself

Event locations (venues)

Field Data type Description values
country_code string Country as an ISO 3166-1 alpha-2 code (ex. "FI")
id integer Unique identifier of this location
latitude float Latitude
locality string City, municipality, etc. Identifies the general area (ex. "Tampere").
longitude float Longitude
name string Name of the venue
phone string Phone number of venue
postal_code string Local postal code (ex. "33100")
street_address_primary string Primary street address of venue (ex. "309 Kent Street")
street_address_secondary string Secondary street address of venue (ex. "Computer Center")
street_address_tertiary string Tertiary street address of venue. Typically unused.
website string URL of venue's website

Event organizers

Field Data type Description values
id integer Unique identifier of this organizer
name string Name of the organizer