GetQuorum Developer Docs (Alpha)

# Meetings API

The Meetings APIs can be used to manage all aspects of a GetQuorum meeting.

# Meeting Endpoints

# Create a meeting

Create a meeting.

Valid meeting types are:

  • agm: Annual General Meetings
  • vbm: Virtual Board Meetings
  • town: Town hall
  • other: Other type of meeting
POST /Accounts/{key}/meetings

# Path Params

Property Type Description
key string The UUID of the Account

# Request

{
  "name": "MTCC 1234 - AGM 2016",
  "description": "General Matters and Election of Directors.",
  "type": "agm",
  "quorumMinimum": 100,
  "meetingDate": "2022-03-12T03:54:45.053Z",
  "expiryDate": "2022-03-12T03:54:45.053Z",
  "location": "1234 Evergreen Terrace, Toronto, Ontario, Canada",
  "duration": 90,
  "options": {
    "signature": "<b>Frank Grimes</b><br>PM of 123 Evergreen Terrace<br>123-432-1234",
    "notificationFrequency": "daily",
    "meetingSubtype": "In Person",
    "virtualMeetingType": "GQ-Hosted"
  },
  "portalRevocationsClosedAt": "2022-03-12T03:54:45.053Z",
  "nominationExpiryDate": "2022-03-12T03:54:45.053Z"
}
Property Type Description
name string Meeting name
description string Description of meeting
quorumMinimum number Minimum required for quorum
type string Type of meeting
meetingDate datetime The date and time of the meeting
expiryDate datetime The date and time when early voting closes
location string The location of the meeting
duration number The duration of the meeting in minutes
option object (WIP)
portalRevocationsClosedAt datetime (WIP)
nominationExpiryDate datetime (WIP)

# Response

{
  "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
  "shortCode": "tscc1234",
  "name": "MTCC 1234 - AGM 2016",
  "description": "General Matters and Election of Directors.",
  "type": "agm",
  "corporation": {
    "legalName": "Metropolitan Toronto Condominium Corporation No. 1234",
    "legalNameShort": "MTCC 1234"
  },
  "quorumMinimum": 100,
  "meetingDate": "2022-03-12T03:44:29.801Z",
  "expiryDate": "2022-03-12T03:44:29.801Z",
  "location": "1234 Evergreen Terrace, Toronto, Ontario, Canada",
  "addresses": ["123 Evergreen Terrace", "125 Evergreen Terrace"],
  "contact": {
    "email": "user@example.com",
    "name": "Homer Simpson, PM",
    "preferredName": "Homer"
  },
  "meetingTimezone": "America/Toronto",
  "duration": 90,
  "options": {
    "signature": "<b>Frank Grimes</b><br>PM of 123 Evergreen Terrace<br>123-432-1234",
    "notificationFrequency": "daily",
    "meetingSubtype": "In Person",
    "virtualMeetingType": "GQ-Hosted"
  },
  "portalRevocationsClosedAt": "2022-03-12T03:44:29.801Z",
  "url": "https://<shortCode>.getquorumapp.com",
  "nominationExpiryDate": "2022-03-12T03:44:29.801Z",
  "liveVotingStatus": "disabled",
  "createdAt": "2018-02-22T19:05:04.931Z",
  "updatedAt": "2018-02-22T19:05:04.931Z"
}

# List meetings

List an Account's meetings

GET /Accounts/{key}/meetings

# Path Params

Property Type Description
key string The UUID of the Account

# Query Params

Property Type Description
searchText string Filter by meeting names that contain the specified search text
limit number Limit the number of record returned. Default 50. Min 1. Max 100.

# Response

[
  {
    "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
    "shortCode": "tscc1234",
    "name": "MTCC 1234 - AGM 2016",
    "description": "General Matters and Election of Directors.",
    "type": "agm",
    "corporation": {
      "legalName": "Metropolitan Toronto Condominium Corporation No. 1234",
      "legalNameShort": "MTCC 1234"
    },
    "quorumMinimum": 100,
    "meetingDate": "2022-03-12T03:44:29.801Z",
    "expiryDate": "2022-03-12T03:44:29.801Z",
    "location": "1234 Evergreen Terrace, Toronto, Ontario, Canada",
    "addresses": ["123 Evergreen Terrace", "125 Evergreen Terrace"],
    "contact": {
      "email": "user@example.com",
      "name": "Homer Simpson, PM",
      "preferredName": "Homer"
    },
    "meetingTimezone": "America/Toronto",
    "duration": 90,
    "options": {
      "signature": "<b>Frank Grimes</b><br>PM of 123 Evergreen Terrace<br>123-432-1234",
      "notificationFrequency": "daily",
      "meetingSubtype": "In Person",
      "virtualMeetingType": "GQ-Hosted"
    },
    "portalRevocationsClosedAt": "2022-03-12T03:44:29.801Z",
    "url": "https://<shortCode>.getquorumapp.com",
    "nominationExpiryDate": "2022-03-12T03:44:29.801Z",
    "liveVotingStatus": "disabled",
    "createdAt": "2018-02-22T19:05:04.931Z",
    "updatedAt": "2018-02-22T19:05:04.931Z"
  }
]

# Get meeting

Find a meeting

GET /Meetings/{shortCode}

# Path Params

Property Type Description
shortCode string The meeting's unique short code

# Response

{
  "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
  "shortCode": "tscc1234",
  "name": "MTCC 1234 - AGM 2016",
  "description": "General Matters and Election of Directors.",
  "type": "agm",
  "corporation": {
    "legalName": "Metropolitan Toronto Condominium Corporation No. 1234",
    "legalNameShort": "MTCC 1234"
  },
  "quorumMinimum": 100,
  "meetingDate": "2022-03-12T03:44:29.801Z",
  "expiryDate": "2022-03-12T03:44:29.801Z",
  "location": "1234 Evergreen Terrace, Toronto, Ontario, Canada",
  "addresses": ["123 Evergreen Terrace", "125 Evergreen Terrace"],
  "contact": {
    "email": "user@example.com",
    "name": "Homer Simpson, PM",
    "preferredName": "Homer"
  },
  "meetingTimezone": "America/Toronto",
  "duration": 90,
  "options": {
    "signature": "<b>Frank Grimes</b><br>PM of 123 Evergreen Terrace<br>123-432-1234",
    "notificationFrequency": "daily",
    "meetingSubtype": "In Person",
    "virtualMeetingType": "GQ-Hosted"
  },
  "portalRevocationsClosedAt": "2022-03-12T03:44:29.801Z",
  "url": "https://<shortCode>.getquorumapp.com",
  "nominationExpiryDate": "2022-03-12T03:44:29.801Z",
  "liveVotingStatus": "disabled",
  "createdAt": "2018-02-22T19:05:04.931Z",
  "updatedAt": "2018-02-22T19:05:04.931Z"
}

# Update meeting

Update a meeting

PATCH /Meetings/{shortCode}

# Path Params

Property Type Description
shortCode string The meeting's unique short code

# Request

{
  "name": "MTCC 1234 - AGM 2016",
  "description": "General Matters and Election of Directors.",
  "type": "agm",
  "quorumMinimum": 100,
  "meetingDate": "2022-03-12T03:54:45.053Z",
  "expiryDate": "2022-03-12T03:54:45.053Z",
  "location": "1234 Evergreen Terrace, Toronto, Ontario, Canada",
  "duration": 90,
  "options": {
    "signature": "<b>Frank Grimes</b><br>PM of 123 Evergreen Terrace<br>123-432-1234",
    "notificationFrequency": "daily",
    "meetingSubtype": "In Person",
    "virtualMeetingType": "GQ-Hosted"
  },
  "portalRevocationsClosedAt": "2022-03-12T03:54:45.053Z",
  "nominationExpiryDate": "2022-03-12T03:54:45.053Z"
}
Property Type Description
name string Meeting name
description string Description of meeting
quorumMinimum number Minimum required for quorum
meetingDate datetime The date and time of the meeting
expiryDate datetime The date and time when early voting closes
location string The location of the meeting
duration number The duration of the meeting in minutes
option object (WIP)
portalRevocationsClosedAt datetime (WIP)
nominationExpiryDate datetime (WIP)

# Response

{
  "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
  "shortCode": "tscc1234",
  "name": "MTCC 1234 - AGM 2016",
  "description": "General Matters and Election of Directors.",
  "type": "agm",
  "corporation": {
    "legalName": "Metropolitan Toronto Condominium Corporation No. 1234",
    "legalNameShort": "MTCC 1234"
  },
  "quorumMinimum": 100,
  "meetingDate": "2022-03-12T03:44:29.801Z",
  "expiryDate": "2022-03-12T03:44:29.801Z",
  "location": "1234 Evergreen Terrace, Toronto, Ontario, Canada",
  "addresses": ["123 Evergreen Terrace", "125 Evergreen Terrace"],
  "contact": {
    "email": "user@example.com",
    "name": "Homer Simpson, PM",
    "preferredName": "Homer"
  },
  "meetingTimezone": "America/Toronto",
  "duration": 90,
  "options": {
    "signature": "<b>Frank Grimes</b><br>PM of 123 Evergreen Terrace<br>123-432-1234",
    "notificationFrequency": "daily",
    "meetingSubtype": "In Person",
    "virtualMeetingType": "GQ-Hosted"
  },
  "portalRevocationsClosedAt": "2022-03-12T03:44:29.801Z",
  "url": "https://<shortCode>.getquorumapp.com",
  "nominationExpiryDate": "2022-03-12T03:44:29.801Z",
  "liveVotingStatus": "disabled",
  "createdAt": "2018-02-22T19:05:04.931Z",
  "updatedAt": "2018-02-22T19:05:04.931Z"
}

# Get meeting settings

Get a meeting's settings

GET /Meetings/{shortCode}/settings

# Path Params

Property Type Description
shortCode string The meeting's unique short code

# Response

{
  "meetingReminders": "enabled",
  "meetingReminderFrequency": 5,
  "meetingStartingReminder": 30,
  "managerSummaryReportFreqency": "daily",
  "alternateManagerContactEmails": [
    "manager2@example.com",
    "manager3@example.com"
  ],
  "defaultProxyHolders": [
    "President of Corporation",
    "Secretary of Corporation"
  ]
}

# Update meeting settings

Update a meeting's settings

PATCH /Meetings/{shortCode}/settings

# Path Params

Property Type Description
shortCode string The meeting's unique short code

# Request

{
  "meetingReminderFrequency": 5,
  "meetingStartingReminder": 30,
  "managerSummaryReportFreqency": "daily",
  "alternateManagerEmails": ["manager2@example.com", "manager3@example.com"],
  "defaultProxyHolders": [
    "President of Corporation",
    "Secretary of Corporation"
  ]
}
Property Type Description
meetingReminderFrequency number Number of days in between meeting reminder emails to the membership. Set to 0 to disable reminders
meetingStartingReminder number Number of minutes before the meeting to send the "Meeting is Starting" reminder. Set to 0 to disable.
managerSummaryReportFreqency string How often managers receive meeting summary report emails. Options are daily or none. Default is daily.
alternateManagerEmails string[] Additional email addresses to send manager summary reports to
defaultProxyHolders string[] An optional list of default proxy holders

# Response

{
  "meetingReminders": "enabled",
  "meetingReminderFrequency": 5,
  "meetingStartingReminder": 30,
  "managerSummaryReportFreqency": "daily",
  "alternateManagerContactEmails": [
    "manager2@example.com",
    "manager3@example.com"
  ],
  "defaultProxyHolders": [
    "President of Corporation",
    "Secretary of Corporation"
  ]
}

# Get meeting stats

Get a meeting's stats

GET /Meetings/{shortCode}/stats

# Path Params

Property Type Description
shortCode string The meeting's unique short code

# Response

{
  "attendanceCount": 100,
  "attendanceCountGroups": 0,
  "attendanceSharesCount": 0,
  "attendedNotVotedCount": 100,
  "attendedNotVotedCountGroups": 0,
  "attendedNotVotedSharesCount": 0,
  "attendingCount": 100,
  "attendingCountGroups": 0,
  "attendingNotVotedCount": 0,
  "attendingNotVotedCountGroups": 0,
  "attendingNotVotedSharesCount": 0,
  "attendingSharesCount": 0,
  "bylawCount": 100,
  "cachedAt": "2022-03-12T04:18:03.744Z",
  "noticeStatusSummary": "string",
  "questions": {
    "by-law": 1,
    "general-elections": 1
  },
  "rtvPresence": {
    "numUnits": 0,
    "numVoters": 0
  },
  "testVoterStats": "string",
  "totalConsents": 100,
  "totalElectronicProxies": 0,
  "totalPaperProxies": 0,
  "totalProxies": 100,
  "totalProxiesShares": 0,
  "totalUnitGroups": 0,
  "totalUnits": 100,
  "totalUnitsShares": 0,
  "totalValidUnits": 100,
  "totalVoters": 100,
  "unverifiedProxyCount": 100,
  "verifiedProxyCount": 100,
  "totalArrearsUnitAttendance": 100,
  "totalArrearsShareAttendance": 0.4
}

← Documents API →