These API docs outline functionality available in the Breeze Cloud API. You can get your API key from Settings -> API Key in your Breeze Clound account.
\nAll requests have to include the API key, as a header:
\nAuthorization: Bearer {{api_key}}
There are costs associated with using this API, depending on your Breeze Cloud plan. Read more about plans and pricing here.
\nIf there is a missing function in the API, or your are having issues, please reach out to our support team.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42700911","collectionId":"2b7af904-8ccc-4681-93d8-f10fe5bb91ca","publishedId":"2sAYdhLWJF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4048FF"},"publishDate":"2025-03-01T23:50:32.000Z"},"item":[{"name":"Session Data","id":"e3645957-9f98-4afb-9d8c-e27f6ae1c682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://eventkite.app/api/event-sessions/{{session_id}}?with=files,email_shares,surveys,text_shares","description":"This endpoint allows you to get all the session data by specifying a session ID. Use the \"with\" parameter to return additional data as needed.
\n","urlObject":{"protocol":"https","path":["api","event-sessions","{{session_id}}"],"host":["eventkite","app"],"query":[{"key":"with","value":"files,email_shares,surveys,text_shares"}],"variable":[]}},"response":[],"_postman_id":"e3645957-9f98-4afb-9d8c-e27f6ae1c682"},{"name":"Find Events","event":[{"listen":"test","script":{"id":"111c10bc-5aca-48b9-8cdc-e58d881b4692","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f4853664-27bb-4d59-8cbc-bbaad463cc76","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/json"}],"url":"https://eventkite.app/api/events?order[event_name]=desc&event_name=Westgarth","description":"This endpoint allows you to find an event. You can list all events (and order by date or event name), as well as search by date and event name.
\n","urlObject":{"protocol":"https","path":["api","events"],"host":["eventkite","app"],"query":[{"key":"order[event_name]","value":"desc"},{"disabled":true,"key":"order[date]","value":"asc"},{"key":"event_name","value":"Westgarth"},{"disabled":true,"key":"date","value":"2024-02-10"},{"disabled":true,"key":"gallery_id","value":"a1a3715e492c90e63cc9694d9be41ffb"}],"variable":[]}},"response":[],"_postman_id":"f4853664-27bb-4d59-8cbc-bbaad463cc76"},{"name":"Find Media","event":[{"listen":"test","script":{"id":"933db033-1296-42ef-84d8-0cdce1295c73","exec":[""],"type":"text/javascript","packages":{}}}],"id":"2953b9e8-6907-41b6-bbe5-c96679b5a0fe","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/json"}],"url":"https://eventkite.app/api/event-files/find?session_uid=LOO667FFX&gallery_id={{gallery_id}}","description":"Returns all media and associated information for a search.
\nissues:
\nnot an array with session data?? no session_id flag
\nsharethis domain when custom domain
\nupdating to session_id
\n","type":"text/plain"},"key":"session_uid","value":"LOO667FFX"},{"key":"gallery_id","value":"{{gallery_id}}"}],"variable":[]}},"response":[],"_postman_id":"2953b9e8-6907-41b6-bbe5-c96679b5a0fe"},{"name":"Create Event","event":[{"listen":"test","script":{"id":"130412d9-16b5-455a-b5f5-e264a4cd247c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"13c827bc-0c2e-4756-9ec9-4b9b5822a02f","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"event_name","value":"API event #1"},{"key":"gallery_id","value":"api-slug-999234"},{"key":"date","value":"2025-02-28"},{"key":"description","value":"API event description"},{"key":"footer","value":"Custom footer text"},{"key":"microsite_description","value":"Microsite description"},{"key":"microsite_footer","value":"Microsite footer"},{"key":"template_id","value":"6","description":"beta feature not available to public
\n","disabled":true}]},"url":"https://eventkite.app/api/events","urlObject":{"protocol":"https","path":["api","events"],"host":["eventkite","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"13c827bc-0c2e-4756-9ec9-4b9b5822a02f"},{"name":"Upload Media","event":[{"listen":"test","script":{"id":"117419c0-30ba-4f10-8da4-abbd788676ab","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a99d0d04-8c93-4b87-a8e6-3fdd214d1e0a","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"session_id","value":"LOO667FFX","description":"What sesson to upload the media to (optional)
\n"},{"key":"file","type":"file","description":"The file to upload (mandatory)
\n","src":"zvOeWRa6w/android-chrome-192x192.png"},{"key":"gallery_id","value":"488e69fb653eba091d749699b98bc6a9","description":"The gallery ID to upload to (mandatory)
\n"},{"key":"es1","value":"","description":"Set event string 1 (optional)
\n","type":"text","uuid":"8aa3d82e-10e6-407d-9d1b-3301e0c15034"},{"key":"es2","value":"","description":"Set event string 2 (optional)
\n","type":"text","uuid":"b9bcce09-0054-40b3-b29f-e93b9cc15dee"},{"key":"es3","value":"","description":"Set event string 3 (optional)
\n","type":"text","uuid":"4202cf12-a969-4b32-957c-fc62cdb3955f"},{"key":"es4","value":"","description":"Set event string 4 (optional)
\n","type":"text","uuid":"32cd4c0a-b6ab-42e5-a99d-b1934f8a5f25"},{"key":"es5","value":"","description":"Set event string 5 (optional)
\n","type":"text","uuid":"7616ac75-d669-4e69-8731-73c750ff0b45"},{"key":"es6","value":"","description":"Set event string 6 (optional)
\n","type":"text","uuid":"d36e4a64-39b9-4945-9b9b-547b68201bd6"},{"key":"es7","value":"","description":"Set event string 7 (optional)
\n","type":"text","uuid":"cb9152bc-d7af-4fcf-9d1f-8222751fa4bd"},{"key":"es8","value":"","description":"Set event string 8 (optional)
\n","type":"text","uuid":"2844456e-a882-403a-98a3-b2119247c174"},{"key":"es9","value":"","description":"Set event string 9 (optional)
\n","type":"text","uuid":"f02b9663-947f-4c34-a784-3224b79f0635"},{"key":"es10","value":"","description":"Set event string 10 (optional)
\n","type":"text","uuid":"053523be-2bad-46e6-bd27-ff7576528d30"}]},"url":"https://eventkite.app/api/event-files/upload","description":"not work?
\n","urlObject":{"protocol":"https","path":["api","event-files","upload"],"host":["eventkite","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a99d0d04-8c93-4b87-a8e6-3fdd214d1e0a"},{"name":"Upload Media By a Link","event":[{"listen":"test","script":{"id":"ddde8074-859f-43df-b269-4fd4f8c3937d","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"620a7603-bfba-4ad1-b66b-0bc278aa0b67","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"session_id","value":"123123","description":"What sesson to upload the media to (optional)
\n"},{"key":"file","value":"https://www.alleycat.org/wp-content/uploads/2019/03/FELV-cat.jpg","description":"The link to to the file to upload (mandatory)
\n"},{"key":"gallery_id","value":"488e69fb653eba091d749699b98bc6a9","description":"The gallery ID to upload to (mandatory)
\n","type":"text","uuid":"c5ab3948-5872-4501-be75-1a4494a70bfe"},{"key":"es1","value":"","description":"Set event string 1 (optional)
\n","type":"text","uuid":"eab3b6da-acc8-47b1-873f-b41539dba6ce"},{"key":"es2","value":"","description":"Set event string 2 (optional)
\n","type":"text","uuid":"9c0a29ad-2555-4752-821d-296c604deea1"},{"key":"es3","value":"","description":"Set event string 3 (optional)
\n","type":"text","uuid":"671535b4-0f2e-49c0-9557-da74df9f36ea"},{"key":"es4","value":"","description":"Set event string 4 (optional)
\n","type":"text","uuid":"7461d857-887a-4b44-9ff2-2a8b7bc55eaf"},{"key":"es5","value":"","description":"Set event string 5 (optional)
\n","type":"text","uuid":"7310dc57-bc22-49ee-ab4f-d23df1802fdd"},{"key":"es6","value":"","description":"Set event string 6 (optional)
\n","type":"text","uuid":"a4c21c5e-6191-4095-badc-5e1f1c5643a0"},{"key":"es7","value":"","description":"Set event string 7 (optional)
\n","type":"text","uuid":"fcec29b7-b618-4e7b-8057-23916076dc8d"},{"key":"es8","value":"","description":"Set event string 8 (optional)
\n","type":"text","uuid":"199e52e4-fcf7-4980-b07b-7f41bf44bcdf"},{"key":"es9","value":"","description":"Set event string 9 (optional)
\n","type":"text","uuid":"9e3da8ca-9e0c-4854-8dd0-0bd004ad6f72"},{"key":"es10","value":"","description":"Set event string 10 (optional)
\n","type":"text","uuid":"a9fe685b-2cc7-4a70-842c-38209425f182"}]},"url":"https://eventkite.app/api/event-files/upload-using-link","urlObject":{"protocol":"https","path":["api","event-files","upload-using-link"],"host":["eventkite","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"620a7603-bfba-4ad1-b66b-0bc278aa0b67"},{"name":"Change Event Visibility","event":[{"listen":"test","script":{"id":"6324ffe2-e69d-4425-9755-011bc3902827","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f8f8ba36-e566-47bc-ba0b-41bf057d8289","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"hidden","value":"0","description":"0 is visible, 1 is hidden
\n"}]},"url":"/api/events/{{gallery_id}}/change-visibility","description":"Allows you to hide the event from your gallery list page.
\n","urlObject":{"path":["api","events","{{gallery_id}}","change-visibility"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f8f8ba36-e566-47bc-ba0b-41bf057d8289"},{"name":"Change Session Visibility","event":[{"listen":"test","script":{"id":"f90b2f64-eaac-4ac6-bb76-395aaa122802","exec":[""],"type":"text/javascript","packages":{}}}],"id":"b5e8f88d-0063-4fca-ab0f-2b1a8c16333d","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"blocked","value":"0","description":"1 disables the session from all views including the gallery and direct session link
\n"},{"key":"hidden","value":"1","description":"1 hides the session from the gallery, but direct session link will work
\n"}]},"url":"https://eventkite.app/api/event-sessions/{{session_id}}/change-visibility","description":"Allows you to change the visibility status of a session.
\n","urlObject":{"protocol":"https","path":["api","event-sessions","{{session_id}}","change-visibility"],"host":["eventkite","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5e8f88d-0063-4fca-ab0f-2b1a8c16333d"},{"name":"Update Session","event":[{"listen":"test","script":{"id":"49a95af0-d3b0-4a95-a452-5d874ac411f8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"001596f9-5087-4b57-a35f-b0b25475d2af","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"description","value":"changed sesssion description"},{"key":"footer","value":"changed session footer"}]},"url":"https://eventkite.app/api/event-sessions/{{session_id}}/update","description":"Allows you to update a session. Currently we allow for setting a custom session description and footer.
\n","urlObject":{"protocol":"https","path":["api","event-sessions","{{session_id}}","update"],"host":["eventkite","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"001596f9-5087-4b57-a35f-b0b25475d2af"},{"name":"Send Status URL Command to Device [beta]","event":[{"listen":"test","script":{"id":"84936ef1-3096-42aa-8abd-8296c4697bb6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"333df662-fa2b-42fd-9830-e42d43f0b6fb","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"command","value":"{\"ts\":\"stillsStart\"}"}]},"url":"https://eventkite.app/api/devices/{{device_id}}","description":"Allows you to send a Status URL command to the specified device.
\nThis feature is not available to all users, please contact us to get beta access to this feature.
\n","urlObject":{"protocol":"https","path":["api","devices","{{device_id}}"],"host":["eventkite","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"333df662-fa2b-42fd-9830-e42d43f0b6fb"},{"name":"List Devices [beta]","event":[{"listen":"test","script":{"id":"84936ef1-3096-42aa-8abd-8296c4697bb6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"52fcd8c6-ea8b-4437-a96e-062a7f6a4779","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"command","value":"{\"ts\":\"stillsStart\"}"}]},"url":"https://eventkite.app/api/devices?name=","description":"Allows you to list your devices and get the device ID
\nThis feature is not available to all users, please contact us to get beta access to this feature.
\n","urlObject":{"protocol":"https","path":["api","devices"],"host":["eventkite","app"],"query":[{"key":"name","value":""}],"variable":[]}},"response":[],"_postman_id":"52fcd8c6-ea8b-4437-a96e-062a7f6a4779"}],"variable":[{"key":"host","value":"","type":"default"},{"key":"token","value":"","type":"default"}]}