GET api/users/{id}

Retrieves detailed information about a specific user by ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the user to retrieve.	integer	Required

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with user details. On failure: HTTP 400 Bad Request if the user is not found or an error occurs.

ViewUserDTO

Name	Description	Type	Additional information
userID	Unique User ID within the system and should be used when referencing the user in subsequent API calls	integer	None.
userName	User Name - User account required to logon to the system	string	None.
firstName	First Name	string	None.
lastName	Last Name	string	None.
email	Users email address	string	None.
customFields		Collection of DataViewColumn	None.
status	The status of the user (active / deleted)	string	None.
createDate	The date the user was added to the site.	date	None.
groups	The groups the user is a member of	Collection of GroupDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "userID": 1,
  "userName": "sample string 2",
  "firstName": "sample string 3",
  "lastName": "sample string 4",
  "email": "sample string 5",
  "customFields": [
    {
      "values": [
        "sample string 1",
        "sample string 2"
      ],
      "guid": "sample string 1",
      "type": "sample string 2",
      "dataType": "sample string 3"
    },
    {
      "values": [
        "sample string 1",
        "sample string 2"
      ],
      "guid": "sample string 1",
      "type": "sample string 2",
      "dataType": "sample string 3"
    }
  ],
  "status": "sample string 6",
  "createDate": "2025-11-20T22:01:55.3224831+00:00",
  "groups": [
    {
      "name": "sample string 1",
      "id": 2
    },
    {
      "name": "sample string 1",
      "id": 2
    }
  ]
}

application/scim+json

Sample:

{
  "userID": 1,
  "userName": "sample string 2",
  "firstName": "sample string 3",
  "lastName": "sample string 4",
  "email": "sample string 5",
  "customFields": [
    {
      "values": [
        "sample string 1",
        "sample string 2"
      ],
      "guid": "sample string 1",
      "label": null,
      "type": "sample string 2",
      "dataType": "sample string 3"
    },
    {
      "values": [
        "sample string 1",
        "sample string 2"
      ],
      "guid": "sample string 1",
      "label": null,
      "type": "sample string 2",
      "dataType": "sample string 3"
    }
  ],
  "status": "sample string 6",
  "createDate": "2025-11-20T22:01:55.3224831+00:00",
  "groups": [
    {
      "name": "sample string 1",
      "id": 2
    },
    {
      "name": "sample string 1",
      "id": 2
    }
  ]
}