Getting started

Create an API key via the user settings in the admin panel. Please note that this is only avaliable for customers with our Business plan.

Url

The API url is https://api.confetti.events and you include the API key via the header named authorization. See example below.

Endpoints

Code & examples

You can find an example of the API in action at this page and the source code is avaliable at GitHub.

Data format

The data from the API is formatted in accordance with the JSON API specification. It's recommended to use a parser for transforming the data before using it in your app, for example Yayson built by us at Confetti and used internally in our apps.

Example

const request = require('request-promise'); const {Store} = require('yayson')(); const store = new Store(); const data = await request({ uri: 'https://app.confetti.events/events', headers: { 'authorization': 'apikey ' + API_KEY }, json: true }); const fotmattedData = store.sync(data);

Raw response

{ "data": { "id": "23756", "type": "event", "attributes": { "name": "My test event", "startDate": "2020-05-15T16:00:00.000Z", "endDate": "2020-05-15T19:00:00.000Z", "timeZone": "Europe/Berlin", "slug": "moccasin-present-569b70", "status": "open", "featureLevel": "business", "signupType": "rsvp", "publishedAt": "2019-08-14T14:10:22.250Z", "theme": "default", "website": "https://api-test-event-1.confetti.events", "email": "api-test@confetti.events", "rsvpLimit": 40, "rsvpLeft": 40, "waitlisted": 1, "hasPassed": false, "createdAt": "2019-08-14T14:10:16.529Z", "updatedAt": "2019-08-28T15:44:33.195Z", "summary": "Write a three sentence pitch for your event here.", "timeFormat": "24", "locale": "en", "primaryColor": "#00DBC3", "colors": {}, "waitlist": true, "location": { "name": "Our loaction", "address": "Österlånggatan 17, Stockholm", "url": "http://www.google.com/maps?q=%C3%96sterl%C3%A5nggatan%2017%2C%20111%2031%20Stockholm%2C%20Sweden", "city": "Stockholm", "country": "Sweden", "postalCode": "111 31" } }, "relationships": { "organisation": { "data": null }, "images": { "data": [ { "id": "423417", "type": "image" } ] }, "categories": { "data": [] } } }, "included": [ { "id": "423417", "type": "image", "attributes": { "url": null, "description": null, "public_id": "default-images/26", "order": null, "width": null, "height": null, "provider": "default", "content": null, "createdAt": "2019-08-14T14:10:16.712Z", "updatedAt": "2019-08-14T14:10:16.712Z", "eventId": 23756, "organisationId": null, "blockId": null, "original": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/original.jpg", "url30": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url30.jpg", "url50": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url50.jpg", "url75": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url75.jpg", "url100": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url100.jpg", "url300": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url300.jpg", "url500": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url500.jpg", "url500x500": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url500.jpg", "url1000": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url1000.jpg", "url2000": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url2000.jpg", "urlMax2000": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/urlMax2000.jpg", "organisation": null, "block": null, "imageType": "cover" } } ] }

Formatted via Yayson

{ "name": "My test event", "startDate": "2020-05-15T16:00:00.000Z", "endDate": "2020-05-15T19:00:00.000Z", "timeZone": "Europe/Berlin", "slug": "moccasin-present-569b70", "status": "open", "featureLevel": "business", "signupType": "rsvp", "publishedAt": "2019-08-14T14:10:22.250Z", "theme": "default", "website": "https://api-test-event-1.confetti.events", "email": "api-test@confetti.events", "rsvpLimit": 40, "rsvpLeft": 40, "waitlisted": 1, "hasPassed": false, "createdAt": "2019-08-14T14:10:16.529Z", "updatedAt": "2019-08-28T15:44:33.195Z", "summary": "Write a three sentence pitch for your event here.", "timeFormat": "24", "locale": "en", "primaryColor": "#00DBC3", "colors": {}, "waitlist": true, "location": { "name": "Our loaction", "address": "Österlånggatan 17, Stockholm", "url": "http://www.google.com/maps?q=%C3%96sterl%C3%A5nggatan%2017%2C%20111%2031%20Stockholm%2C%20Sweden", "city": "Stockholm", "country": "Sweden", "postalCode": "111 31" }, "id": "23756", "type": "event", "organisation": null, "images": [ { "url": null, "description": null, "public_id": "default-images/26", "order": null, "width": null, "height": null, "provider": "default", "content": null, "createdAt": "2019-08-14T14:10:16.712Z", "updatedAt": "2019-08-14T14:10:16.712Z", "eventId": 23756, "organisationId": null, "blockId": null, "original": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/original.jpg", "url30": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url30.jpg", "url50": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url50.jpg", "url75": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url75.jpg", "url100": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url100.jpg", "url300": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url300.jpg", "url500": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url500.jpg", "url500x500": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url500.jpg", "url1000": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url1000.jpg", "url2000": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/url2000.jpg", "urlMax2000": "//d2wd18kp3k18ix.cloudfront.net/default-images/26/urlMax2000.jpg", "organisation": null, "block": null, "imageType": "cover", "id": "423417", "type": "image" } ], "categories": [] }