Zencity Engage Public API Documentation for GET List of Engagements

API requests must be made with the Content-Type of application/vnd.api+json

List Engagements Endpoint

This endpoint returns a list of all engagements with their statuses currently in your Zencity Engage instance.

GET /api/v1/engagements

The following fields are available:

{
   "data":[
      {
         "id": ID,
         "type": STRING,
         "attributes":{
            "title": STRING,
            "description": STRING,
            "start_time": DATETIME,
            "end_time": DATETIME,
            "public_status": STRING,
            "submissions_count": INTEGER,
            "minutes_to_complete": INTEGER,
            "link_text": STRING,
            "button_text": STRING,
            "redirect_url": STRING,
            "slug": STRING,
            "languages": [STRING]
         },
         "relationships":{
            "project":{
               "data":{
                  "id": ID,
                  "type": STRING
               }
            }
         }
      }
   }

Example

    
{
   "data":[
      {
         "id":"20",
         "type":"engagement",
         "attributes":{
            "title":"Virtual Town Hall Part 1: Information Boards and Consulation",
            "description":"With COVID-19 making it unfeasible for us to welcome the community in person, our task force has assembled a virtual town hall.  Please come in, take part, share your thoughts, and help us to continue to take care of our city's most vulnerable",
            "start_time":"2020-03-20T00:00:00.000-07:00",
            "end_time":"2021-11-30T12:00:00.000-08:00",
            "public_status":"open",
            "submissions_count":201,
            "minutes_to_complete":7,
            "link_text":null,
            "button_text":null,
            "redirect_url":null,
            "slug":"virtual-town-hall-part-1-information-boards-and-consulation",
            "languages":[
               "en"
            ]
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"8",
                  "type":"project"
               }
            }
         }
      },
      {
         "id":"25",
         "type":"engagement",
         "attributes":{
            "title":"Open House #1",
            "description":"Join as at the Lion's Hall on Front Street for this in-person session.\r\n7:00-9:00pm",
            "start_time":"2020-03-01T19:00:00.000-08:00",
            "end_time":"2020-03-01T21:00:00.000-08:00",
            "public_status":"closed",
            "submissions_count":0,
            "minutes_to_complete":2,
            "link_text":null,
            "button_text":null,
            "redirect_url":null,
            "slug":"open-house-1",
            "languages":[
               "en"
            ]
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"8",
                  "type":"project"
               }
            }
         }
      },
      {
         "id":"5",
         "type":"engagement",
         "attributes":{
            "title":"Southside Bike Lane Expansion",
            "description":"We're going to spend the rest of 2019 ensuring that we get our bike lane planning right.  This engagement is your chance to provide input at the start of the process.  We'd love to hear from you.",
            "start_time":"2019-04-09T17:00:00.000-07:00",
            "end_time":null,
            "public_status":"open",
            "submissions_count":47,
            "minutes_to_complete":7,
            "link_text":null,
            "button_text":null,
            "redirect_url":null,
            "slug":"southside-bike-lane-expansion",
            "languages":[
               "en"
            ]
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"3",
                  "type":"project"
               }
            }
         }
      },
      {
         "id":"8",
         "type":"engagement",
         "attributes":{
            "title":"Open House #2",
            "description":"If you missed our evening open house last month, here is your chance to attend a morning session where you can ask questions and discuss your concerns and hopes with other engaged citizens",
            "start_time":"2020-01-07T16:00:00.000-08:00",
            "end_time":null,
            "public_status":"open",
            "submissions_count":14
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"4",
                  "type":"project"
               }
            }
         }
      },
      {
         "id":"2",
         "type":"engagement",
         "attributes":{
            "title":"Online Public Outreach",
            "description":"Can't make it out in person to our Town Hall or Forum?  No worries.  Click below to share your perspective from a mobile phone, laptop, tablet, whatever.  We can't wait to hear from you.",
            "start_time":"2018-12-31T16:00:00.000-08:00",
            "end_time":null,
            "public_status":"open",
            "submissions_count":48
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"2",
                  "type":"project"
               }
            }
         }
      },
      {
         "id":"6",
         "type":"engagement",
         "attributes":{
            "title":"Open House - Solutions Workshop",
            "description":"Come and be a part of an action-packed night where you'll both learn from our environmental and engineering reports, and then have a chance to roll up your sleeves and help plan the next iteration of pedestrian and bike-friendly thoroughfares in Pittsburgh.",
            "start_time":"2019-11-06T16:00:00.000-08:00",
            "end_time":null,
            "public_status":"open",
            "submissions_count":19,
            "minutes_to_complete":2,
            "link_text":null,
            "button_text":null,
            "redirect_url":null,
            "slug":null,
            "languages":[
               "en"
            ]
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"3",
                  "type":"project"
               }
            }
         }
      },
      {
         "id":"1",
         "type":"engagement",
         "attributes":{
            "title":"Commenting Test",
            "description":"test",
            "start_time":"2020-10-31T16:00:00.000-07:00",
            "end_time":null,
            "public_status":"open",
            "submissions_count":1
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"1",
                  "type":"project"
               }
            }
         }
      },
      {
         "id":"12",
         "type":"engagement",
         "attributes":{
            "title":"Transportation Survey",
            "description":"Elm Street is a critical transportation and development corridor linking to Highway 20 and beyond. This project is to improve pedestrian, bicycle, bus and motorist routes along Elm street to alleviate the challenges that we currently face. ",
            "start_time":"2019-11-17T16:00:00.000-08:00",
            "end_time":null,
            "public_status":"open",
            "submissions_count":8
         },
         "relationships":{
            "project":{
               "data":{
                  "id":"5",
                  "type":"project"
               }
            }
         }
      },
   ]
}