Skip to main content
GET
Get Ringg Spaces
Use it for a tenant dashboard in your own admin tool, to check headroom before allocating concurrency or credit, and to reconcile per-client usage at month end.

Reading the response

  • family.concurrency_available is what Allocate Concurrency can still hand out; family.available_pot (prepaid) is what Reallocate Credit Balances can still move out of the primary.
  • family.is_individual_entity tells you the billing mode: true for individual (each Ringg Space has its own wallet or limit), false for common (one pool on the primary). The keys present in family and in each row’s billing depend on it; the response schema below lists them per mode.
  • usage_this_period is the value of completed calls since the 1st of the current month in the Asia/Kolkata timezone, in the workspace’s billing currency.
  • Amounts are JSON numbers here (200000.0); the two allocation endpoints return decimal strings.

Notes

  • Works on a primary with no Ringg Spaces yet; sub_workspaces is then an empty list.
  • Archived Ringg Spaces are not listed.

Errors

  • 400: Sub-workspaces cannot have their own sub-workspaces. — the key belongs to a Ringg Space that has Ringg Spaces enabled.
  • 401: Invalid or missing API key.
  • 403: Sub-workspaces are not enabled for this workspace. — Ringg Spaces are not enabled on the primary, or the key belongs to a Ringg Space.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) The API key of the PRIMARY workspace. A Ringg Space's own key is refused (403, or 400 if Ringg Spaces are enabled on it).

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

Successful Response: The family overview.

primary
object
sub_workspaces
object[]

Active Ringg Spaces, oldest first.

family
object

Family totals. Always: the concurrency keys and is_individual_entity. Postpaid families add credit_limit, utilized_total, available_total. Prepaid individual families add available_pot, allocated_balance_total, family_available_total. Prepaid common families add available_pot and family_available_total.