Get users

GET 
/users

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

Request

Query Parameters

query object

Allows for pagination and sorting.

name string

object name for filtering

login string

The user login to search by

title string

The user title to search by

status string

Possible values: [Active, Inactive, On Leave, Terminated]

status value for filtering

email email

The user email to search by

metadata boolean

Returns batching metadata in the response

Responses

200

Expected response to a valid request

application/json

Schema

Schema

users object[]
Array [
id uuid
uid string
Possible values: >= 32 characters and <= 32 characters
name string
email email
type string
Possible values: [NeprofileUser, NeaccessUser]
Default value: NeprofileUser
title string
status string
Possible values: [Active, Disabled]
login string
last_login date-time
cookies_accepted_at date-time
preferred_language string
]
_metadata object
limit integer
offset integer
total integer
next string
previous string

Example (from schema)

{
  "users": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "uid": "string",
      "name": "string",
      "email": "[email protected]",
      "type": "NeprofileUser",
      "title": "string",
      "status": "Active",
      "login": "string",
      "last_login": "2024-05-06T18:24:33.141Z",
      "cookies_accepted_at": "2024-05-06T18:24:33.141Z",
      "preferred_language": "string"
    }
  ],
  "_metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...