List of user fields [API GetUsersProperties]

Question asked by Tim Winkelmann - 3/4/2019 at 1:44 AM

Answered

Hi,

Where can I find the complete list of field names that can be queried with the API using:

/Services2/svcOrganization.asmx/GetUsersProperties

I was able to guess a few, such as "displayname", "email", "password", "username", but guess-work is not productive.

I want to know, for example, the name of the "user preferred language" field.

Also, the name of the "View Organization tickets in portal" field (through this one might not be linked to the user, rather to the organization. I don't know).

I find that every time a list of string fields has to be given to an API call, the possible fields are not documented.

Is that right ? Or is there documentation for this ?

Thanks in advance.

Tim Winkelmann

4 Replies

Reply to Thread

Andrew Barker Replied

3/4/2019 at 7:13 AM

Employee Post Marked As Answer

In your instance of SmarterTrack, you can find the API Documentation under Tools in the Settings area. The API documentation for the latest version can also be found at https://portal.smartertools.com/Services2/. If you navigate to the section for GetUsersProperties under svcOrganization, it includes a list of the values that can be passed for the requestedValues property in the description.

I did notice that there is a space in the listing for the value "AvatarUrl". This is incorrect, and we will be fixing this in a coming update. Also, it seems that the values "AverageKbRating" and "TotalKbRatings" were incorrectly included in this list.

Andrew Barker Software Developer SmarterTools Inc. www.smartertools.com

Tim Winkelmann Replied

3/4/2019 at 7:52 AM

Thank you for your answer.

After finding the doc, I can confirm AvatarUrl does work without space and AverageKbRating and TotalKbRatings don't exist.

So is it possible to get the user language as well as know if they are allowed to list organization tickets ("View Organization tickets in portal") from another API call ?

Thanks in advance.