Get All User Workspaces
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/all \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/all"
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/all', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspaces": [
{
"id": "00000000-0000-4000-8000-000000000112",
"name": "Acme Lending",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"role": "owner",
"parent_workspace_id": null,
"credits": 3025,
"locked_credits": 0
}
]
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Get All User Workspaces
List every workspace the API key’s user can access, with role, credits and parent workspace, to see which workspaces are Ringg Spaces of a primary.
GET
/
workspace
/
all
Get All User Workspaces
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/all \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/all"
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/all', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspaces": [
{
"id": "00000000-0000-4000-8000-000000000112",
"name": "Acme Lending",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"role": "owner",
"parent_workspace_id": null,
"credits": 3025,
"locked_credits": 0
}
]
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}A workspace with
parent_workspace_id set is a Ringg Space of that primary.
Notes
- Calls, campaigns and analytics always act on the workspace that owns the key. To work in another workspace from this list, use that workspace’s own key.
Was this page helpful?