> For the complete documentation index, see [llms.txt](https://interfacing.gitbook.io/interfacing-help-files/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://interfacing.gitbook.io/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/retrieve-users.md).

# Retrieve Users

The `GET /admin/users` endpoint allows you to retrieve a list of users from the IMS database. This supports various scenarios including:

* Exporting user lists for reporting or auditing purposes
* Synchronizing IMS users with an external system (e.g., HR, SSO)
* Generating statistics and metrics on users

***

## Quick Start

* **Base Endpoint URL:** <https://YOURIMS.interfacing.com/api/v1/admin/users>
* **Authentication**: Obtain a valid token (see [Authentication & Token Management](/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis.md#authentication-and-token-management))
* **Swagger URL:** <https://YOURIMS.interfacing.com/api/v1/swagger/#/User/findUsers>

{% hint style="warning" %}
**Permission Requirement**\
Only users with **System Administrator** privileges can access this functionality. Ensure the authenticated user has the appropriate permissions before making this API call.
{% endhint %}

***

## CURL Request Example

```bash
curl --request GET --url 'http://myims.interfacing.com/api/v1/admin/users/1450CEF9-89A3-4B48-98F7-09735BECD54B?draft=true' -b /tmp/cookie.tmp
```

***

## Client Integration (Java)

```java
public <T extends NodeElement> Mono<T> findElement(@NotNull String nodeId, Class<T> clazz) {
        return bpcClient.get()
                .uri(uriBuilder -> uriBuilder.path("/items/{nodeId}").queryParams(defaultQueryParams).queryParam("detail", true).build(nodeId))
                .retrieve()
                .bodyToMono(new ParameterizedTypeReference<>() {
                });
    }
```

***

## What is this feature in IMS?

<mark style="color:red;">In IMS, users can be managed through the</mark> <mark style="color:red;"></mark><mark style="color:red;">**Users tab**</mark> <mark style="color:red;"></mark><mark style="color:red;">within the</mark> <mark style="color:red;"></mark><mark style="color:red;">**System Administration**</mark> <mark style="color:red;"></mark><mark style="color:red;">section. This feature allows administrators to view and manage all user profiles, including employees, resources, and stakeholders.</mark>&#x20;

<mark style="color:red;">User records can be sorted by attributes like username, first name, last name, or email.</mark>&#x20;

<mark style="color:red;">Only users with System Administrator privileges have access to this tab, so when making this API call, ensure the authenticated user has the appropriate permissions.</mark>

<mark style="color:red;">To learn more about managing users in IMS, click here.</mark>

***

## See Also

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td>Authentication &#x26; Token Management</td><td><a href="/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis.md#authentication-and-token-management">REST APIs</a></td><td><a href="https://1488562728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTx7AmE0d2Q4ja20EYjF5%2Fuploads%2FLfvkwix26vW3CnepEMTv%2FIMS-V16-NAV-Home-Icons-5.png?alt=media&amp;token=4244c676-38ac-4218-8552-680a3ac1dcdc">IMS-V16-NAV-Home-Icons-5.png</a></td></tr><tr><td>API Reference (Swagger)</td><td><a href="/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/api-reference-swagger.md">API Reference (Swagger)</a></td><td><a href="https://1488562728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTx7AmE0d2Q4ja20EYjF5%2Fuploads%2FuIm0jP36LBJWUKIgHGxl%2FIMS-V16-NAV-Library-Icons-41.png?alt=media&amp;token=a91c1498-c99a-4013-b6bd-5877df0a71bb">IMS-V16-NAV-Library-Icons-41.png</a></td></tr><tr><td>How to Perform Other Use Cases</td><td><a href="/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/how-to-perform-other-use-cases.md">How to Perform Other Use Cases</a></td><td><a href="https://1488562728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTx7AmE0d2Q4ja20EYjF5%2Fuploads%2F5Aeu2y0v898h8TlT2GMk%2FIMS-V16-Intro-7.png?alt=media&amp;token=4c09eacd-abdd-44d1-b318-8d6dbb4a11b1">IMS-V16-Intro-7.png</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://interfacing.gitbook.io/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/retrieve-users.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.