List Workspace Users
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/users \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/users"
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/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspace_users": [
{
"id": "00000000-0000-4000-8000-000000000111",
"username": "priya.sharma",
"email": "user@example.com",
"role": "member",
"invite_status": "success"
}
]
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}List Workspace Users
List the members of your workspace with their user ID, name, email, role and invite status, for example to pick who gets a campaign completion email.
GET
/
workspace
/
users
List Workspace Users
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/users \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/users"
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/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspace_users": [
{
"id": "00000000-0000-4000-8000-000000000111",
"username": "priya.sharma",
"email": "user@example.com",
"role": "member",
"invite_status": "success"
}
]
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Use the
id values in email_completion_user_ids when starting a campaign (number pool or large campaign) to email those members when it completes.
Notes
- The API only reads members. Invite people and change roles in the dashboard.
Authorizations
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Query Parameters
Number of items to return.
Example:
50
Number of items to skip (default: 0).
Example:
20
Response
Successful Response: A list of users in the workspace.
Show child attributes
Show child attributes
Was this page helpful?