Skip to main content
NICE CXone Expert
Expert Success Center

users/{userid}/properties/{key}/info (GET)


Retrieve the metadata about a user property

  • REST Method: GET
  • Method Access: public

Uri Parameters

Name Type Description
key string A unique identifier for a property that is obtained through GET:users/{userid}/properties
userid string either an integer user ID, "current", or "=" followed by a double uri-encoded user name

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)
redirects int? If zero, do not follow page redirects.
contentcutoff int? Only show property content shorter than this number of bytes. Default: 2048

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 ADMIN access is required to access other user's properties
Not Found 404 Requested user and/or property could not be found

Message Format

Response is the standard property XML

<property name="{text}" href="{uri}" etag="{text}">
  <contents type="{text}" href="{uri}">{text}</contents>
  <user.modified id="{int}" href="{uri}">

Implementation Notes

  • The response XML will contain the contents text only for text based mimetypes with values less than 2048 chars in length. Otherwise the contents is available at the URI pointed to by property/contents/@href.

C# Code Sample: Retrieve Metadata of a User Property

The following code authenticates and retrieves information about a user property named 'foo' .

Sample Code

Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
XDoc ret = p.At("users", "current", "properties", "foo", "info")

Sample Response from executing Code

<property name="foo" href="http://devwiki/@api/deki/users/1/properties/foo/info" etag="4463.r1_ts2009-03-20T22:48:15Z">
  <contents type="text/plain; charset=utf-8" href="http://devwiki/@api/deki/users/1/properties/foo">My Value</contents>
  <user.modified id="1" href="http://devwiki/@api/deki/users/1">
  <change-description>initial value</change-description>

Curl Code Sample: Retrieve Metadata of a User Property

The following command retrieves information about property "foo" associated to user "bar":

Sample Code

curl -u admin:password -i http://mindtouch.address/@api/deki/users/properties/foo/info

Sample Response from executing Code

Example of retrieving the metadata of the user property listed here:

Content-Type: application/xml

<property name="foo" href="" etag="116.r1_ts2010-02-02T22:47:40Z">
  <contents type="text/plain" size="3" href="">bar</contents>
  <user.modified id="1" href="">
    <email hidden="true"/>

Implementation notes 

curl flags

Provides external user authentication.
Outputs the HTTP response headers. Useful for debugging.


ADMIN permission is required to execute above command unless an authenticated user performs the request on themselves.

User Properties

To view a list of a user's properties, follow the instructions here.


  • Was this article helpful?