Get system users

Returns all system users visible to the authenticated user, optionally filtered by ACL role.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do

Returns all system users visible to the authenticated user, optionally filtered by ACL role. The 'roles' parameter accepts a comma-separated list of role IDs (numeric) or role names (string), and only users matching at least one of the specified roles are returned. If no 'roles' parameter is provided, all system users are returned. A value that names no role is refused with 400, listing the roles whose users the caller can see. Results are not paginated (all matching users are returned at once). Requires authentication.

Query Params

roles string

Comma-separated list of ACL role IDs (e.g., '1,2') or role names (e.g., 'publisher,advertiser') to filter the results. If omitted, all system users are returned.

publisher,advertiser

Responses

200

JSON array of system user objects with user details

400

A roles value that names no role

401

Unauthorized — authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/system-users.do?roles=publisher%2Cadvertiser")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body