Skip to main content
GET
/
workspace
/
users
List Workspace Users
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace/users \
  --header 'X-API-KEY: <x-api-key>'
{
  "workspace_users": [
    {
      "id": "7251cb4b-3373-43a4-844c-b27a1d45e0c9",
      "username": "sahil",
      "email": "user@example.com",
      "role": "member",
      "invite_status": "success"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.ringg.ai/llms.txt

Use this file to discover all available pages before exploring further.

List users who belong to the current workspace. This is useful for internal admin tooling, audit views, and choosing users for campaign completion notifications.

​
Query guidance

  • Use limit and offset for pagination.
  • Keep the API key server-side; do not call this endpoint from browser code.
  • Cache lightly if you show this in dashboards because workspace membership changes infrequently.

​
Common follow-up

Campaign APIs can notify selected users when a campaign completes. Use this endpoint to identify the user IDs available in the workspace.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

​
limit
integer
default:10

Number of items to return (default: 20, max: 100).

Example:

50

​
offset
integer
default:0

Number of items to skip (default: 0).

Example:

20

Response

Successful Response: A list of users in the workspace.

​
workspace_users
object[]