---
title: "Search system users"
type: reference
method: GET
path: /rest-api/system-users/search.do
tag: "Users"
---

# Search system users

`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

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `activeOnly` | boolean | no | `false` | When true, only active (not deactivated) users are returned |
| `limit` | integer | no | `50` | Page size, 1 to 500 |
| `query` | string | no | `mara` | Substring of the username, e-mail, first name or last name. Omit to list everyone visible. |
| `roles` | string | no | `Advertiser` | Comma-separated role ids or role names (case-insensitive), e.g. '4,Publisher'. Omit for every visible role. |
| `start` | integer | no | `0` | 0-based offset of the first user to return |

## 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

## Example request

```bash
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'
```

Source: https://epom.com/ad-server/docs/api/users/get-system-users-search