Get users
GET/users
This endpoint can retrieve users from Lifecycle or you can search for users using parameters
Request
Query Parameters
Allows for pagination and sorting.
object name for filtering
The user login to search by
The user title to search by
Possible values: [Active, Inactive, On Leave, Terminated]
status value for filtering
The user email to search by
Returns batching metadata in the response
Responses
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
users
object[]
ID of the object to retrieve or update
Possible values: >= 32 characters and <= 32 characters
UID of the user
The name
The email
Possible values: [NeprofileUser, NeaccessUser]
Default value: NeprofileUser
Type of user
The title
Possible values: [Active, Disabled]
Status of the user
The login
When the user last logged in
When cookies were accepted
The locale the user prefers to use
The locale the user prefers to use
_metadata
object
{
"users": [
{
"id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"uid": "user1",
"name": "myusername",
"email": "[email protected]",
"type": "NeprofileUser",
"title": "Director",
"status": "Active",
"login": "myLogin",
"last_login": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"cookies_accepted_at": "Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00",
"preferred_language": "fr-CA",
"locale": "fr-CA"
}
],
"_metadata": {
"limit": 0,
"offset": 0,
"total": 0,
"next": "/endpoint?limit=10&offset=60",
"previous": "/endpoint?limit=10&offset=40"
}
}
Bad Request - unable to complete.
- application/json
- Schema
- Example (from schema)
Schema
- InvalidJson
- ValidationErrors
oneOf
{}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "Sorry something went wrong"
}