Zencity Engage Public API Documentation for GET Idea Board

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

Idea Board

This endpoint returns a list of all idea boards with their statuses that exist in your Zencity Engage instance. 

GET /api/v1/idea_boards/:id

The following fields are available:

{
   "data":{
      "id": ID,
      "type": STRING,
      "attributes":{
         "title": STRING,
         "short_description": STRING,
         "long_description": STRING,
         "start_time": DATETIME,
         "end_time": DATETIME,
         "public_status": STRING,
         "languages": [STRING],
         "ideas_count": INTEGER
      },
      "relationships":{
         "hero_image":{
            "data":{
               "id": ID,
               "type": STRING
            }
         },
         "project":{
            "data":{
               "id": ID,
               "type": STRING
            }
         }
      }
   },
   "included":[
      {
         "id": ID,
         "type": STRING,
         "attributes":{
            "alt_text": STRING,
            "caption": STRING,
            "image_urls":{
               "desktop": STRING,
               "card": STRING,
               "mobile": STRING
            }
         },
         "relationships":{
            
         },
         "links":{
            "self": STRING
         }
      },
      {
         "id": ID,
         "type": STRING,
         "attributes":{
            "title": STRING,
            "introduction": STRING,
            "status": STRING,
            "visible": BOOLEAN,
            "notification_sign_up_enabled": BOOLEAN,
            "slug": STRING,
            "teaser": STRING
         },
         "relationships":{
            "hero_image":{
               "data":{
                  "id": ID,
                  "type": STRING
               }
            }
         },
         "meta":{
            "engagement_sort_order":[INTEGER]
         }
      }
   ]
}

Example

{
   "data":{
      "id":"1",
      "type":"idea_board",
      "attributes":{
         "title":"Idea Board: How can we better inform the community on needs surrounding community housing?",
         "short_description":"What ideas do you have to ensure we're collecting information about need and share it back to the community",
         "long_description":"Please Be kind and creative!",
         "start_time":"2020-08-08T02:02:00.000-04:00",
         "end_time":"2021-12-31T15:01:00.000-05:00",
         "public_status":"open",
         "languages":[
            "en"
         ],
         "ideas_count":8
      },
      "relationships":{
         "hero_image":{
            "data":{
               "id":"158",
               "type":"media"
            }
         },
         "project":{
            "data":{
               "id":"8",
               "type":"project"
            }
         }
      }
   },
   "included":[
      {
         "id":"158",
         "type":"media",
         "attributes":{
            "alt_text":"lit up interchange at night",
            "caption":null,
            "image_urls":{
               "desktop":"/rails/active_storage/representations/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBamNCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f515613f56d11061b47a2e2a121864ffac0d98c4/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCam9MY21WemFYcGxTU0lRTVRrd01DQjRJREV3TnpBR09nWkZWQT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--3ab068344f10fe3d03a80d29c7104ef3c6d11b2f/Hwy%20132%20interchange%20hero.jpeg",
               "card":"/rails/active_storage/representations/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBamNCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f515613f56d11061b47a2e2a121864ffac0d98c4/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCam9MY21WemFYcGxTU0lPTnpNd0lIZ2dOREV3QmpvR1JWUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--d4faa3e36d17f0b616fcf437579e6b66d1a0a4c2/Hwy%20132%20interchange%20hero.jpeg",
               "mobile":"/rails/active_storage/representations/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBamNCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f515613f56d11061b47a2e2a121864ffac0d98c4/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCam9MY21WemFYcGxTU0lPT1RVd0lIZ2dOVE0xQmpvR1JWUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--8d2131399e367f5ccb31190d6adeb7e199516510/Hwy%20132%20interchange%20hero.jpeg"
            }
         },
         "relationships":{
            
         },
         "links":{
            "self":"/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBamNCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f515613f56d11061b47a2e2a121864ffac0d98c4/Hwy%20132%20interchange%20hero.jpeg"
         }
      },
      {
         "id":"96",
         "type":"media",
         "attributes":{
            "alt_text":"Affordable Housing Project",
            "caption":null,
            "image_urls":{
               "desktop":"/rails/active_storage/representations/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBWmM9IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--94f00f48413012894cb1e064989703cbfbebc0e3/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCam9MY21WemFYcGxTU0lRTVRrd01DQjRJREV3TnpBR09nWkZWQT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--3ab068344f10fe3d03a80d29c7104ef3c6d11b2f/affordable%20housing.jpg",
               "card":"/rails/active_storage/representations/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBWmM9IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--94f00f48413012894cb1e064989703cbfbebc0e3/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCam9MY21WemFYcGxTU0lPTnpNd0lIZ2dOREV3QmpvR1JWUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--d4faa3e36d17f0b616fcf437579e6b66d1a0a4c2/affordable%20housing.jpg",
               "mobile":"/rails/active_storage/representations/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBWmM9IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--94f00f48413012894cb1e064989703cbfbebc0e3/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCam9MY21WemFYcGxTU0lPT1RVd0lIZ2dOVE0xQmpvR1JWUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--8d2131399e367f5ccb31190d6adeb7e199516510/affordable%20housing.jpg"
            }
         },
         "relationships":{
            
         },
         "links":{
            "self":"/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBWmM9IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--94f00f48413012894cb1e064989703cbfbebc0e3/affordable%20housing.jpg"
         }
      },
      {
         "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":null
         },
         "relationships":{
            "hero_image":{
               "data":{
                  "id":"96",
                  "type":"media"
               }
            }
         },
         "meta":{
            "engagement_sort_order":[
               20,
               21,
               22,
               23,
               25,
               27,
               33,
               35,
               38,
               42,
               44
            ]
         }
      }
   ]
}