GetQuorum Developer Docs (Alpha)

# Accounts API

An Account represents the customer or sub-customer entity, the Accounts APIs can be used to retrieve this information.

# Account Endpoints

# List accounts

List the user's Accounts

GET /Accounts

# Query Params

Property Type Description
searchText string Filter by account 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",
    "name": "Toronto Standard Condominium Corporation No. 1234",
    "nameShort": "TSCC 1234",
    "address": {
      "address": "123 Anywhere Street",
      "city": "Toronto",
      "prov": "ON",
      "postal": "M1M 1M1",
      "country": "Canada"
    },
    "contactName": "Homer Simpson",
    "contactEmail": "homer@example.com",
    "subscription": {
      "product": "GetQuorum-Annual-License-USD",
      "status": "active"
    },
    "createdAt": "2018-02-22T19:05:04.931Z",
    "updatedAt": "2018-02-22T19:05:04.931Z"
  }
]

Description:

Property Type Description
key string The unique identifer for an Account
name string Account name
nameShort string Abbreviated (aka. nickname) for account
address object (WIP)
contactName string The primary contact
contactEmail string Email of the primary contact
subscription object Subscription status for the Account (WIP)

# Get an account

Find an Account

GET /Accounts/{key}

# Path Params

Property Type Description
key string The UUID of the Account

# Response

{
  "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
  "name": "Toronto Standard Condominium Corporation No. 1234",
  "nameShort": "TSCC 1234",
  "address": {
    "address": "123 Anywhere Street",
    "city": "Toronto",
    "prov": "ON",
    "postal": "M1M 1M1",
    "country": "Canada"
  },
  "contactName": "Homer Simpson",
  "contactEmail": "homer@example.com",
  "subscription": {
    "product": "GetQuorum-Annual-License-USD",
    "status": "active"
  },
  "createdAt": "2018-02-22T19:05:04.931Z",
  "updatedAt": "2018-02-22T19:05:04.931Z"
}

Description:

Property Type Description
key string The unique identifer for an Account
name string Account name
nameShort string Abbreviated (aka. nickname) for account
address object (WIP)
contactName string The primary contact
contactEmail string Email of the primary contact
subscription object Subscription status for the Account (WIP)

# Add user to account

(WIP)

# Remove user from account

(WIP)

← Meetings API →