---
title: "List users based on query filters"
method: GET
path: "/insync/usermanagement/v1/users"
tags: ["Restore OneDrive/Exchange Online data"]
---

# List users based on query filters

`GET /insync/usermanagement/v1/users`

Retrieve a filtered list of users based on query filters.

## Query parameters

- `profileID` integer
- `status` 'active' | 'preserved'
- `storageID` integer
- `minAddedOn` string
- `maxAddedOn` string
- `emailID` string
- `cacheID` integer
- `userIDs` integer[]
- `searchPrefixUserName` string
- `searchPrefixEmailID` string
- `ldapGUID` string
- `privacySettingsEnabled` boolean
- `orderBy` 'userName' | 'emailID' | 'deviceCount' | 'customUniqueID' | 'totalDeviceUsage' | 'm365Usage' | 'googleUsage' | 'cloudappCount' | 'userID'
- `order` 'asc' | 'desc'

## Response `200`

success

- 200ListUsers
  - `totalSize` integer — The total number of users fetched based on applied filters.
  - `nextPageToken` string — The token to access the next page of results. This parameter will be empty for the last page of results.
  - `users` object[]
    - `userName` string — The username of the user in inSync. Example - Ernie Carter
    - `emailID` string — The email address of the user. Example - ernie.carter@druva.com
    - `userID` integer — The unique id of the user in inSync. Example - 1
    - `status` string — The status of the user account. Example - active/preserved
    - `profileID` integer — The profile ID of the profile associated with the user. Example - 1
    - `storageID` integer — The storage ID of the storage associated with the user. Example - 1
    - `quota` integer — The storage quota assigned to the user in inSync. Example - 10 GB
    - `quotaInBytes` integer — The storage quota assigned to the user (in bytes) in inSync. Example - 10737418240
    - `cacheID` integer — The CloudCache Server ID associated with the user. Example - 1
    - `addedOn` string — The date on which the user was added in inSync. Example - 2019-10-25T00:00:00Z
    - `ldapGUID` string — The AD or LDAP object GUID of the user in a hex string format. Example: B1C47201C67910458867BA19982E353E. The ldapGUID displays objectGUID if the user is imported from AD and displays entryUUID if imported from LDAP.
    - `privacySettingsEnabled` boolean — Displays the status of the privacy setting of the user. If the value returned is True, privacy setting is enabled by the user. If the value returned is False, privacy settings is not set or user has allowed admin access to their data.
    - `additionalProperties` object — Contains the two keys of userIdentifierCustomAttribute and userIdentifierCustomAttributeValue if the User-Identifier Custom Attribute feature is enabled for the account and the administrator has opted to display it on the inSync UI. This field remains empty if the administrator has opted to hide the User-Identifier Custom Attribute.

## Other responses

- `400` — Bad Request
- `401` — The request did not include an authentication token or an expired authentication token was supplied.
- `403` — Access denied: Insufficient permissions. User requires specific access rights and minimum permissions. Details: https://help.druva.com/en/articles/15069296
- `404` — The requested resource was not found.
- `500` — The request was not processed due to an internal error on server.
- `501` — Requested HTTP method is not implemented.

---

[API](https://skmtc.net/druva/apis/authentication.md) · [All operations](https://skmtc.net/druva/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/druva/authentication/revisions/2af2bf148b25/schema)