Documentation

/users [GET]

ThoughtFarmer REST API Method: /users [GET]

Gets all of the users.

URL:
http://yourserver.com/api/users

Response Formats:
JSON, XML

HTTP Method(s):
GET

Requires Authentication:
true, user making call must pass a valid token parameter

Parameters:

Parameter Type Description
token string Required. A valid token authentication parameter
Response Status Codes:
200 - Success
401 - Token parameter is invalid

Example request
GET http://yourserver.com/api/users
[
    {
        "userId": 136,
        "contentId": 833,
        "firstName": "Elijah",
        "lastName": "Adams",
        "preferredName": "",
        "salutation": null,
        "email": "eadams@thoughtfarmer.nil",
        "username": "eadams",
        "jobTitle": "Executive Secretary",
        "timeZone": "Pacific Standard Time",
        "defaultCulture": "en",
        "birthday": "",
        "phoneNumbers": {
            "fax": "",
            "mobile": "",
            "tel": ""
        },
        "images": {
            "small": "/profileimage/81203130000/208/50x50/False/0,0,128,128/eadams.jpg",
            "medium": "/profileimage/81203130000/208/250x250/False/0,0,128,128/eadams.jpg",
            "large": "/profileimage/81203130000/208/0x0/False/0,0,128,128/eadams.jpg"
        }
    },
    {
        "userId": 127,
        "contentId": 824,
        "firstName": "Brooke",
        "lastName": "Alexander",
        "preferredName": "",
        "salutation": null,
        "email": "balexander@thoughtfarmer.nil",
        "username": "balexander",
        "jobTitle": "Help Desk Manager",
        "timeZone": "Pacific Standard Time",
        "defaultCulture": "en",
        "birthday": "",
        "phoneNumbers": {
            "fax": "",
            "mobile": "",
            "tel": ""
        },
        "images": {
            "small": "/profileimage/81160970000/199/50x50/False/0/balexander.jpg",
            "medium": "/profileimage/81160970000/199/250x250/False/0/balexander.jpg",
            "large": "/profileimage/81160970000/199/0x0/False/0/balexander.jpg"
        }
    },
    {
        "userId": 146,
        "contentId": 843,
        "firstName": "Thomas",
        "lastName": "Alexander",
        "preferredName": "",
        "salutation": null,
        "email": "talexander@thoughtfarmer.nil",
        "username": "talexander",
        "jobTitle": "Engineer",
        "timeZone": "Pacific Standard Time",
        "defaultCulture": "en",
        "birthday": "",
        "phoneNumbers": {
            "fax": "",
            "mobile": "",
            "tel": ""
        },
        "images": {
            "small": "/profileimage/81251270000/218/50x50/False/0/talexander.jpg",
            "medium": "/profileimage/81251270000/218/250x250/False/0/talexander.jpg",
            "large": "/profileimage/81251270000/218/0x0/False/0/talexander.jpg"
        }
    }
]

NOTE: When an administrator account in Admin Mode is used to connect the API, inactive users will be included in the results.