Zencity Engage Public API Documentation for GET Project

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

Project

This endpoint returns publicly available information about a project that exists in your Zencity Engage instance. 

GET /api/v1/projects/:id

The following fields are available:

{
   "data":{
      "id":ID,
      "type": STRING,
      "attributes":{
         "title": STRING,
         "introduction": STRING,
         "status": STRING,
         "visible": BOOLEAN,
         "notification_sign_up_enabled": BOOLEAN,
         "slug": STRING,
         "teaser": STRING
      },
      "relationships":{
         "public_engagements":{
            "data":[
               {
                  "id": ID,
                  "type": STRING
               },
            ]
         },
         "phases":{
            "data":[
               {
                  "id": ID,
                  "type": STRING
               },
            ]
         },
         "events":{
            "data":[
               {
                  "id": ID,
                  "type": STRING
               }
            ]
         },
         "documents":{
            "data":[
               {
                  "id": ID,
                  "type": STRING
               },
            ]
         },
         "active_announcements":{
            "data":[
               {
                  "id": ID,
                  "type": STRING,
               }
            ]
         },
         "public_idea_boards":{
            "data":[
               {
                  "id": ID,
                  "type": STRING
               }
            ]
         },
         "hero_image":{
            "data":{
               "id": ID,
               "type": STRING
            }
         },
         "supporting_image":{
            "data": {
                "id": ID,
                "type": STRING,
            }
         },
         "video":{
            "data":{
               "id": ID,
               "type": STRING
            }
         },
         "quote":{
            "data":{
               "id": ID,
               "type": STRING
            }
         }
      },
      "meta":{
         "engagement_sort_order":[INTEGER]
      }
   }
}

Example

{
   "data":{
      "id":"8",
      "type":"project",
      "attributes":{
         "title":"Affordable Housing Project",
         "introduction":"This affordable housing project is based on years of research by  the Regional Affordable Housing Strategy and the Housing and Transportation Cost Burden Study - which translate the region's rental housing needs and the high household burden many renters face when housing and transportation costs are considered together.  \r\n\r\nWe're excited to move forward with adding more options in our community, and we want you to be informed of how we're proceeding\r\n\r\nCheck out the assets on this page, and participate in the opportunities below\r\n\r\nFor more information, check out the articles on the urban Institute page",
         "status":"active",
         "visible":true,
         "notification_sign_up_enabled":true,
         "slug":"affordable-housing-project",
         "teaser":"This affordable housing project is based on years of research by the Regional Affordable Housing Strategy and the Housing and Transportation Cost Burden Study - which translate the region's rental housing needs and the high household burden many renters face when housing and transportation costs are considered together. "
      },
      "relationships":{
         "public_engagements":{
            "data":[
               {
                  "id":"20",
                  "type":"engagement"
               },
               {
                  "id":"25",
                  "type":"engagement"
               },
               {
                  "id":"23",
                  "type":"engagement"
               },
               {
                  "id":"22",
                  "type":"engagement"
               },
               {
                  "id":"21",
                  "type":"engagement"
               }
            ]
         },
         "phases":{
            "data":[
               {
                  "id":"28",
                  "type":"phase"
               },
               {
                  "id":"29",
                  "type":"phase"
               },
               {
                  "id":"30",
                  "type":"phase"
               },
               {
                  "id":"31",
                  "type":"phase"
               },
               {
                  "id":"32",
                  "type":"phase"
               },
               {
                  "id":"33",
                  "type":"phase"
               },
               {
                  "id":"34",
                  "type":"phase"
               },
               {
                  "id":"35",
                  "type":"phase"
               }
            ]
         },
         "events":{
            "data":[
               {
                  "id":"7",
                  "type":"event"
               }
            ]
         },
         "documents":{
            "data":[
               {
                  "id":"9",
                  "type":"document"
               },
               {
                  "id":"8",
                  "type":"document"
               },
               {
                  "id":"7",
                  "type":"document"
               },
               {
                  "id":"6",
                  "type":"document"
               }
            ]
         },
         "active_announcements":{
            "data":[
               {
                  "id":"2",
                  "type":"announcement"
               }
            ]
         },
         "public_idea_boards":{
            "data":[
               {
                  "id":"1",
                  "type":"idea_board"
               }
            ]
         },
         "hero_image":{
            "data":{
               "id":"96",
               "type":"media"
            }
         },
         "supporting_image":{
            "data":null
         },
         "video":{
            "data":{
               "id":"37",
               "type":"video"
            }
         },
         "quote":{
            "data":{
               "id":"27",
               "type":"quote"
            }
         }
      },
      "meta":{
         "engagement_sort_order":[
            20,
            21,
            22,
            23,
            25,
            27,
            33,
            35,
            38,
            42,
            44
         ]
      }
   }
}