workspace

the instance's standing against the guest allowance

Changed on

Instance-wide, since a licence is per instance and one email is one guest however many workspaces it opens. Read by workspace admins and app publishers to see how close the cap (Community and Pro) or the meter (Enterprise) is.

get/w/{workspace}/workspaces/guest_usage

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/workspaces/guest_usage
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Response

guest usage

availableboolean required
instance_enabledboolean required
guest_countinteger required
window_daysinteger required
free_allowanceinteger required
meteredboolean required
billable_guestsinteger required
guest_seatsinteger required

Changes