NHnhs-england
[v1] Users

GET /v1

Changed on

Get users list

Request

  • Base URL
    https://nhse-${ENV}-innovation-service-user-functions.azurewebsites.net/api
  • URL
    https://nhse-${ENV}-innovation-service-user-functions.azurewebsites.net/api/v1
  • Auth
    none declared

Query parameters

skipinteger
takeinteger
orderobject
userTypesstring[]

Types of user to filter.

organisationUnitIdstring uuid

Id of the organisation unit the user belongs to.

onlyActiveboolean

List only active users or all users.

fieldsstring[]

Additional fields to display in response.

Response

Success

idstring

Unique identifier for user object

Changes

  • 173650e3e033Revision changes
    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter onlyActive

    • info

      added the new optional query request parameter order

    • info

      added the new optional query request parameter organisationUnitId

    • info

      added the new optional query request parameter skip

    • info

      added the new optional query request parameter take

    • info

      added the new optional query request parameter userTypes