Skip to main content

Get users



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


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


Expected response to a valid request

    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