Overview

Retrieves a specific user with the specified lD. The result of this GET request will be a JSON-encoded representation of a user object. The object definition is provided below.

JSON Object Definition

The following lists properties on the JSON object representing users you may encounter when retrieving a user. Fields with no value set are omitted from the JSON object. For a complete list of user properties and further details, see the User Object Reference.

{
  "id": "",
  "firstName": "",
  "lastName": "",
  "username": "",
  "email": "",
  "tags": [ "", ... ],
  "locale": "",
  "createdDate": "",
  "lastLoginDate": ""
}

Examples

Retrieve a User by ID

This example shows the request/response sequence when requesting a user by id.

Request
GET /dc/api/v5/users/a322881a721f0feaedcbc12876a4510e HTTP/1.1
Host: api.digitalchalk.com
Accept: application/json

Response
HTTP/1.1 200 OK
Content-type: application/json
Content-length: 456 

{
  "id": "a322881a721f0feaedcbc12876a4510e",
  "firstName": "Arnold",
  "lastName": "Marks",
  "username": "amarks",
  "email": "amarks@exampleorg.com",
  "locale": "en",
  "createdDate": "2009-06-07T02:21:40Z",
  "lastLoginDate": "2011-08-02T13:22:48Z"
}

Reference