List Family Members
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/sub/members \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/members"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/sub/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"primary_workspace_id": "00000000-0000-4000-8000-000000000107",
"members": [
{
"user_id": "00000000-0000-4000-8000-000000000106",
"email": "ops.head@acme-lending.example",
"username": "Ops Head",
"role": "owner",
"scope": "primary",
"sub_workspace_ids": [],
"permissions_by_workspace": {
"00000000-0000-4000-8000-000000000107": [
"agents",
"numbers",
"api_keys"
],
"00000000-0000-4000-8000-000000000101": [
"agents",
"numbers",
"api_keys"
]
},
"invite_status": "success"
},
{
"user_id": "00000000-0000-4000-8000-00000000010c",
"email": "mumbai.lead@acme-lending.example",
"username": "mumbai.lead",
"role": "member",
"scope": "sub",
"sub_workspace_ids": [
"00000000-0000-4000-8000-000000000101"
],
"permissions_by_workspace": {
"00000000-0000-4000-8000-000000000101": [
"agents"
]
},
"invite_status": "pending"
}
]
}{
"message": "Sub-workspaces cannot have their own sub-workspaces."
}{
"message": "Invalid credentials"
}{
"message": "Sub-workspaces are not enabled for this workspace."
}{
"message": "An unexpected error occurred. Please try again later."
}List Family Members
List everyone with access to your Ringg Space family, whether they inherit access from the primary or were added to one Ringg Space, with permissions.
GET
/
workspace
/
sub
/
members
List Family Members
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/sub/members \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/members"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/sub/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"primary_workspace_id": "00000000-0000-4000-8000-000000000107",
"members": [
{
"user_id": "00000000-0000-4000-8000-000000000106",
"email": "ops.head@acme-lending.example",
"username": "Ops Head",
"role": "owner",
"scope": "primary",
"sub_workspace_ids": [],
"permissions_by_workspace": {
"00000000-0000-4000-8000-000000000107": [
"agents",
"numbers",
"api_keys"
],
"00000000-0000-4000-8000-000000000101": [
"agents",
"numbers",
"api_keys"
]
},
"invite_status": "success"
},
{
"user_id": "00000000-0000-4000-8000-00000000010c",
"email": "mumbai.lead@acme-lending.example",
"username": "mumbai.lead",
"role": "member",
"scope": "sub",
"sub_workspace_ids": [
"00000000-0000-4000-8000-000000000101"
],
"permissions_by_workspace": {
"00000000-0000-4000-8000-000000000101": [
"agents"
]
},
"invite_status": "pending"
}
]
}{
"message": "Sub-workspaces cannot have their own sub-workspaces."
}{
"message": "Invalid credentials"
}{
"message": "Sub-workspaces are not enabled for this workspace."
}{
"message": "An unexpected error occurred. Please try again later."
}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_workspacealready includes inherited rows, so render access from it rather than deriving it fromscope.- 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
Headers
(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"
Was this page helpful?