Agenda API - Docs

Token Required

This api requires bearer token authorization headings which is provided by AgendaLink in order to put data in and some fetch capabilities. No token is required to fetch public data.

Fetching Data

The root URL is https://api.agendalink.app

Get All Meetings

  GET /api/session/all/:client

Query Filters	Description	Example
`month`	4 digit year number followed by 2 digit month number	?month=2022-11

Response

{
  "data": [
    // array agendas for client.  Ordered from newest to oldest
    {
      "id": "61afd53d932dfe9eb4e10618",
      "board": "City Council",
      "room": {
        "name": "Council Chamber",
        "address": {
          "street": "123 Main St",
          "street2": "",
          "city": "Fort Worth",
          "state": "Texas",
          "zipCode": "76109"
        }
      },
      "scheduleTime": "January 5th, 2022, 7:00 PM",
      "scheduleIso": "2022-01-06T01:00:00.000Z",
      "clientId": "0001",
      "status": "draft", // see below for meanings
      "agendaUrl": "" // url to html agenda
    }
  ]
}

Status

draft: Meeting is being built
draftreview: Meeting is in final review stages
published: Meeting has been published but not run yet
review: Meeting has been published and run, but minutes not approved yet
minutes: Meeting has approved minutes

Get Non-Minutes Meetings

These are any meeting that doesn't have approved minutes

  GET /api/session/pending/:client

Query Filters	Description	Example
`month`	4 digit year number followed by 2 digit month number	?month=2022-11

Response

{
  "data": [
    // array agendas for client.  Ordered from newest to oldest
    {
      "id": "61afd53d932dfe9eb4e10618",
      "board": "City Council",
      "room": {
        "name": "Council Chamber",
        "address": {
          "street": "123 Main St",
          "street2": "",
          "city": "Fort Worth",
          "state": "Texas",
          "zipCode": "76109"
        }
      },
      "scheduleTime": "January 5th, 2022, 7:00 PM",
      "scheduleIso": "2022-01-06T01:00:00.000Z",
      "clientId": "0001",
      "status": "draft", // see below for meanings
      "agendaUrl": "" // url to html agenda
    }
  ]
}

Status

draft: Meeting is being built
draftreview: Meeting is in final review stages
published: Meeting has been published but not run yet
review: Meeting has been published and run, but minutes not approved yet

Get Meeting Minutes

These are any meetings that have approved minutes

  GET /api/session/completed/:client

Query Filters	Description	Example
`month`	4 digit year number followed by 2 digit month number	?month=2022-11

Response

{
  "data": [
    // array containing published minutes for this client. Ordered from newest to oldest
    {
      "id": "61afd53d932dfe9eb4e10618",
      "board": "City Council",
      "room": {
        "name": "Council Chamber",
        "address": {
          "street": "123 Main St",
          "street2": "",
          "city": "Fort Worth",
          "state": "Texas",
          "zipCode": "76109"
        }
      },
      "scheduleTime": "January 5th, 2022, 7:00 PM",
      "scheduleIso": "2022-01-06T01:00:00.000Z",
      "startTime": "",
      "startIso": "",
      "endTime": "",
      "endIso": "",
      "clientId": "0001",
      "agendaUrl": "" // url to html agenda
    }
  ]
}

Get Specific Agenda

  GET /api/session/agenda/:id

Response

{
  "data": {
    "id": "62755452136c5b79c2be1029",
    "scheduleTime": "November 8th, 2022, 7:00 PM",
    "scheduleIso": "2022-11-09T01:00:00.000Z",
    "board": {
      "name": "City Council Regular Meeting",
      "agendaHeadingTitle": "The City of Example will be a self-sustaining city whose small town character has been maintained while still being a diverse and progressive community which provides an exceptional quality of life.",
      "agendaHeadingBlurb": "Pursuant to Section 551.071 of the Texas Government Code, the Council may convene into Executive Session(s) from time\nto time as deemed necessary during the meeting for any posted agenda item, and may receive advice from its attorney as\npermitted by law.",
      "agendaFooterBlurb": "Certification that this was posted details will go here when you fill them out.",
      "agendaFooterNote": "City of Example"
    },
    "topics": [
      // array of topics on agenda
      {
        "title": "Call to Order",
        "votingOption": "NONE",
        // details are formatted for rich text rendering (see Slate.JS for a rendering engine)
        "details": "[{\"type\":\"h1\",\"id\":1648221603665,\"children\":[{\"text\":\"With a quorum of the City Council, the meeting is called to order\"}]},{\"type\":\"paragraph\",\"id\":1650311504365,\"children\":[{\"text\":\"\"}]}]",
        "status": "AGENDAPUB",
        "templateTopic": true,
        "referenceFile": "",
        "presentedBy": "",
        "previewPublish": false,
        "_id": "62755453136c5b79c2be1030",
        "attachments": [],
        "priorities": [
          // any priorities associated with topic will have a true boolean for checked field
          {
            "_id": "62755453136c5b79c2be1035",
            "name": "Affordable Housing",
            "checked": false
          }
        ],
        "itemNumber": "AL-22-0572",
        "agendaGroup": "General"
      }
    ]
  }
}

Get Specific Minutes

  GET /api/session/minutes/:id

Response

{
  "data": {
    "id": "62755452136c5b79c2be1029",
    "scheduleTime": "November 8th, 2022, 7:00 PM",
    "scheduleIso": "2022-11-09T01:00:00.000Z",
    "board": {
      "name": "City Council Regular Meeting",
      "agendaHeadingTitle": "The City of Example will be a self-sustaining city whose small town character has been maintained while still being a diverse and progressive community which provides an exceptional quality of life.",
      "agendaHeadingBlurb": "Pursuant to Section 551.071 of the Texas Government Code, the Council may convene into Executive Session(s) from time\nto time as deemed necessary during the meeting for any posted agenda item, and may receive advice from its attorney as\npermitted by law.",
      "agendaFooterBlurb": "Certification that this was posted details will go here when you fill them out.",
      "agendaFooterNote": "City of Example"
    },
    "topics": [
      // array of topics on agenda
      {
        "title": "Call to Order",
        "votingOption": "NONE",
        // details are formatted for rich text rendering (see Slate.JS for a rendering engine)
        "details": "[{\"type\":\"h1\",\"id\":1648221603665,\"children\":[{\"text\":\"With a quorum of the City Council, the meeting is called to order\"}]},{\"type\":\"paragraph\",\"id\":1650311504365,\"children\":[{\"text\":\"\"}]}]",
        "status": "AGENDAPUB",
        "templateTopic": true,
        "referenceFile": "",
        "presentedBy": "",
        "previewPublish": false,
        "_id": "62755453136c5b79c2be1030",
        "attachments": [],
        "priorities": [
          // any priorities associated with topic will have a true boolean for checked field
          {
            "_id": "62755453136c5b79c2be1035",
            "name": "Affordable Housing",
            "checked": false
          }
        ],
        "itemNumber": "AL-22-0572",
        "agendaGroup": "General"
      }
    ]
  }
}

Updating Data

... Documentation Coming