developer.sailpoint.com/docs/api/nerm/v1/get-users.api.mdx

---
id: get-users
sidebar_label: Get users
hide_title: true
hide_table_of_contents: true
api: eJy1V91P4zgQ/1csP9xTaQu33EMldOrpuFVPfJyAvRdUITeZtF4SO2s7pVXV/31n7CQNEEIpdzzQ2B57vn8zs+E6ByOc1GoS8xGfg/tmwVje4zHYyMicjvDgbiEtAxXnWirHIqGYAWckLIEVdIElRmfsQiYQraMUmDZsrQtPaEGYaMES3AqkhZVqznJhRAYuMHNibvnonnsCPu3xxunofsMVLlCKHwWYNZJL1Vg8F3ScpvrJem65mEvldWNCxcxq45BxH68Y+FFIA6hxIlILPW6jBWSCjzbcrXPipGffIXJImhuykJNg6TSVmXQNMjQGzMEgHaxElqe4dzwcbntcJ4mFdyhPPaGJcXdHZ9Gqat4k45EB4SB+EI5vt42DWhxkueN4OqwffXnTurV/MAbIrysFYZWnOsZtZwrY9mpb+59OUwcbMSL09k5kig4L0r9v4VLRbYNlqtFh3TzvFiHgmKdlTlfhNVsfytVJl76jac3V0/4nXK0TrrDdbAMNW4q0+ISF0cWqyCi7xpGTS1J1okT1ea3YBQj/eQcmo4TBN6dNUfFVme5pIE97sIF6HLXMMForpk0xEA5ELJzoluQGXGGUZTPhogXhTHWNUbigmAZsrpWFveSaaZ2CUJ5LIorU1aR1Fvq02U7ptfCwB4qT4ZB+nst2vsoxYSCuZSBDCfKvpD1UyFJGRhqxQnnwEHmeyshj2OC7pUc2e2NVwNIdmTBGePB0kNn3r8u40z9FgQSktIi1StcVfPCi/R4G1gWouVvw0a8nuBSr5vLVK8Hlr/KnV4bFHoHTKynezoYrQIUxo4AqHu5fgYgisNYvpw2Pv6Ckpz1ktMlXpvU+SfintGKW+mTrldDX9mIqrHt447ihNoY4HDmZQemU66Y5I60f0a0PpGBeFoSDH8sNJGAwbR5SoeaFmLdZYmckTkY7OvFbD3UOH1xpu2orMdVOpO1HClatWu8K7aBqcH733M+Oh78EXme/DXnQfCn1G+7d45Uvw2eGuayMsfV/Pf6lDTT+EDG7CdjAjlihKGYINyJN/Bz0P4IYWsF14juql9avhJooD0d/01UC37fo/iUqz+bcGI1As50GJU7blJigfEaJlN2CWWKZ8HdQHePRGhERe7RCLbBNw4RgsKIwxZv2Q8p1BxQQy9eSjbFAWItBzML+jGoG1YlA33TsrTZmjW0kBrGvLE8oFXsy2sd76UI602UnTSIIgjg+KMqm2nr1Q09bGAxUvnAut6PBYIM6CuWuEPi2fYV+QqZ6DdBHPw9ELvHyUhhJ3g/xV5MHnSqsElEGkX5doD156NWEtXJORqcoKqxDhQxpMCX5osJIt/YCzrCEgxkXpML9tHl8SzYPcjSJaheQUrwsp76MeiLcCR9/VThzpx+Bmjj8f4bjggmfPkmkSjS9SOYKKhz3h/1hIwKvzm8u2fifSWszUh36CWTmmxOvb4B4Pw9kOpbJmpFVMaepJqMEeEqNghcG1FKidzN0M8UhRh5Q3zCqO5LLyZ2XNdfWZUI1Tr6CY0XbILXZhfP/PlMFXziEvUGeCkn5HIJuU8ZlY95aoAq0sdnMhIVvJt1uaTv0WBQMcVWtqgboTbW6xoJWmR5hvZs3fLOLSw8++zPtngs62FYzx2f5tk4GHXyrqeNAvp2jQQfbeuz4rL6tjX4H42qIOJDvR9r6DikaM8ROkOkOWj3QYTZgz0MDNMZ9uDf2jVPj1qtKRK/U4P/1nIDhJ51W/bo=
sidebar_class_name: "get api-method"
info_path: docs/api/nerm/v1/nerm-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get users' (get-users)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Get users</h1>

<MethodEndpoint method={"get"} path={"/users"}></MethodEndpoint>



This endpoint can retrieve users from Lifecycle or you can search for users using parameters

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"query","in":"query","description":"Allows for pagination and sorting.","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","example":100},"offset":{"type":"integer","example":50},"order":{"type":"string","example":"created_at"}},"example":{"limit":100,"offset":50,"order":"created_at"}},"style":"deepObject","explode":true}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"name","in":"query","description":"object name for filtering","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"login","in":"query","description":"The user login to search by","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"title","in":"query","description":"The user title to search by","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"status","in":"query","description":"status value for filtering","required":false,"schema":{"type":"string","enum":["Active","Inactive","On Leave","Terminated"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"email","in":"query","description":"The user email to search by","required":false,"schema":{"type":"string","format":"email"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"schema":{"type":"boolean","default":false,"example":true}}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Expected response to a valid request

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>users</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readonly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Disabled`]"} schema={{"type":"string","enum":["Active","Disabled"]}}></SchemaItem><SchemaItem collapsible={false} name={"login"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"last_login"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"cookies_accepted_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"preferred_language"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>_metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"offset"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"total"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"next"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=60"}}></SchemaItem><SchemaItem collapsible={false} name={"previous"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=40"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"users\": [\n    {\n      \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"uid\": \"string\",\n      \"name\": \"string\",\n      \"email\": \"user@example.com\",\n      \"type\": \"NeprofileUser\",\n      \"title\": \"string\",\n      \"status\": \"Active\",\n      \"login\": \"string\",\n      \"last_login\": \"2024-03-06T21:09:31.794Z\",\n      \"cookies_accepted_at\": \"2024-03-06T21:09:31.794Z\",\n      \"preferred_language\": \"string\"\n    }\n  ],\n  \"_metadata\": {\n    \"limit\": 0,\n    \"offset\": 0,\n    \"total\": 0,\n    \"next\": \"/endpoint?limit=10&offset=60\",\n    \"previous\": \"/endpoint?limit=10&offset=40\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad Request - unable to complete.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - returned on unhandled exceptions.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"Sorry something went wrong"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>