Get configured users

Get Configured Users

curl --request GET \
  --url https://api.operata.io/v2/admin/users \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.operata.io/v2/admin/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v2/admin/users"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v2/admin/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

" {\n \"id\": 714,\n        \"name\": \"Andy Admin\",\n        \"groups\": [\n            {\n                \"id\": \"a28453f9-c9d3-xxxx-xxxx-84d9e67ac297\",\n                \"name\": \"Operata Demo\",\n                \"ccp\": \"https://operata-prod.awsapps.com/connect/ccp-v2\"\n            }\n        ],\n        \"email\": \"andy+admin@operata.com\",\n        \"role\": \"Group Admin\"\n    }"

"<html>\n\n<head>\n\t<title>401 Authorization Required</title>\n</head>\n\n<body>\n\t<center>\n\t\t<h1>401 Authorization Required</h1>\n\t</center>\n\t<hr>\n\t<center>nginx/1.19.2</center>\n</body>\n\n</html>"

"Call Summary record could not be found"

GET

admin

users

Get Configured Users

curl --request GET \
  --url https://api.operata.io/v2/admin/users \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.operata.io/v2/admin/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v2/admin/users"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v2/admin/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

" {\n \"id\": 714,\n        \"name\": \"Andy Admin\",\n        \"groups\": [\n            {\n                \"id\": \"a28453f9-c9d3-xxxx-xxxx-84d9e67ac297\",\n                \"name\": \"Operata Demo\",\n                \"ccp\": \"https://operata-prod.awsapps.com/connect/ccp-v2\"\n            }\n        ],\n        \"email\": \"andy+admin@operata.com\",\n        \"role\": \"Group Admin\"\n    }"

"<html>\n\n<head>\n\t<title>401 Authorization Required</title>\n</head>\n\n<body>\n\t<center>\n\t\t<h1>401 Authorization Required</h1>\n\t</center>\n\t<hr>\n\t<center>nginx/1.19.2</center>\n</body>\n\n</html>"

"Call Summary record could not be found"

Returns every teammate configured in the Operata account, with each user’s role and the groups they belong to. Use it to audit who has access or to map Operata user IDs to your own identity store.

Endpoint

GET https://api.operata.io/v2/admin/users

Parameters

This endpoint takes no parameters. Credentials on the request determine the Operata account scope.

Response

200 OK with the configured users for the account.

[
  {
    "id": 714,
    "name": "Andy Admin",
    "email": "admin@example.com",
    "role": "Group Admin",
    "groups": [
      {
        "id": "a28453f9-abab-cdcd-efef-84d9e67ac297",
        "name": "Operata Demo",
        "ccp": "https://operata-prod.awsapps.com/connect/ccp-v2"
      }
    ]
  }
]

Field	Type	Description
`id`	integer	Stable internal user ID.
`name`	string	Display name as configured in the Operata console.
`email`	string	The user’s login email.
`role`	string	The user’s role. Today: `Group Admin` or `User`. Treat as an opaque string — additional roles may appear without a version bump.
`groups`	array	Each Operata account the user belongs to, with the CCP URL for that group.
`groups[].id`	string (UUID)	The Operata Group ID for that account. Used as the username for HTTP Basic on API requests.
`groups[].name`	string	Human-readable group name.
`groups[].ccp`	string (URL)	The Amazon Connect CCP URL associated with the group.

Example

curl -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  "https://api.operata.io/v2/admin/users"

const groupId = process.env.OPERATA_GROUP_ID;
const apiToken = process.env.OPERATA_API_TOKEN;
const auth = Buffer.from(`${groupId}:${apiToken}`).toString("base64");

const response = await fetch("https://api.operata.io/v2/admin/users", {
  headers: { Authorization: `Basic ${auth}` },
});
const users = await response.json();

import os, requests

response = requests.get(
    "https://api.operata.io/v2/admin/users",
    auth=(os.environ["OPERATA_GROUP_ID"], os.environ["OPERATA_API_TOKEN"]),
)
response.raise_for_status()
users = response.json()

Errors

Status	Code	When	Recover
403	`forbidden`	The token belongs to a user without the Admin role.	Generate a token from an account with the Group Admin role under Settings → Config → API.
404	`not_found`	No users exist in the Operata account this token authenticates to.	Confirm you sent the right `Operata Group ID` in the Basic credentials.

See Errors for shared codes such as 401 unauthorized, 429 rate_limited, and the 5xx family.

Authentication — how the Operata Group ID returned in groups[].id authenticates API requests.
Versioning — this endpoint lives under /v2; the versioning policy explains how /v1 and /v2 coexist.
Errors — shared status codes and recovery patterns.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200

integer

default:0

Example:

714

name

string

Example:

"Andy Admin"

groups

object[]

Show child attributes

string

Example:

"andy+admin@operata.com"

role

string

Example:

"Group Admin"

Query CCP logs

Data redaction

Overview & quickstart

API essentials

Endpoints — Contacts

Endpoints — Logs

Endpoints — Users

Endpoints — Data redaction

Events & webhooks

Streaming & backends

AI & MCP

Endpoint

Parameters

Response

Example

Errors

Authorizations

Response

​Endpoint

​Parameters

​Response

​Example

​Errors

​Related

Authorizations

Response

Endpoint

Parameters

Response

Example

Errors

Related