Search system users

Reference

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

Finds the users the caller may see in the console's Users grid, one page at a time: the users of every role the caller's role has VIEW access to (a Network Manager sees the publishers, advertisers and other accounts it manages). 'query' matches a substring of the username, e-mail, first name, last name or admin comment. 'roles' narrows the result to roles given by id or name (comma-separated, names case-insensitive); a role the caller cannot see yields no users, and a value that names no role at all is refused with the list of roles the caller can see. Use the returned userId wherever an endpoint asks for a user, e.g. advertiser or site shares. Passwords and API keys are never returned.

Query Params

activeOnly boolean

When true, only active (not deactivated) users are returned

false

limit integer

Page size, 1 to 500

50

query string

Substring of the username, e-mail, first name or last name. Omit to list everyone visible.

mara

roles string

Comma-separated role ids or role names (case-insensitive), e.g. '4,Publisher'. Omit for every visible role.

Advertiser

start integer

0-based offset of the first user to return

0

Responses

200

Page of users sorted by userId: {success, total, start, limit, users:[{userId, username, email, firstName, lastName, roleId, role, status, created, referer, referredUsers}]}

400

A 'roles' value names no role, or 'start'/'limit' is out of range

401

Unauthorized — authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/system-users/search.do?activeOnly=false&limit=50&query=mara' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/system-users/search.do?activeOnly=false&limit=50&query=mara", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/system-users/search.do?activeOnly=false&limit=50&query=mara', {
  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/search.do?activeOnly=false&limit=50&query=mara"))
    .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/search.do?activeOnly=false&limit=50&query=mara");
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/search.do?activeOnly=false&limit=50&query=mara", 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/search.do?activeOnly=false&limit=50&query=mara");
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/search.do?activeOnly=false&limit=50&query=mara")
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