Skip to main content
GET
List Family Members
Members of the primary (scope: "primary") inherit access to every current and future Ringg Space; people added directly to a Ringg Space (scope: "sub") see only the Ringg Spaces in their sub_workspace_ids. Use it for access audits across client or team workspaces, or to show who can reach a Ringg Space in your own admin tool.

Notes

  • permissions_by_workspace already includes inherited rows, so render access from it rather than deriving it from scope.
  • The endpoint only reads. Add or remove people in the dashboard (Workspace members).

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 member matrix.

primary_workspace_id
string
Example:

"00000000-0000-4000-8000-000000000107"

members
object[]