getUserInfo
A Graze API GET request that returns information about a specified user.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint getUserInfo
takes the following request arguments:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String |
Yes |
A valid |
|
Number |
Yes |
ID of the the user to return information about. |
|
String |
Yes |
A valid username. |
Response
Endpoint getUserInfo
returns the following response:
Successful requests return a JSON object containing the following:
Name |
Type |
Description |
---|---|---|
|
Number |
User ID. |
|
String |
Full name of the user. |
Examples
The following examples demonstrate typical use of endpoint getUserInfo
:
Request example
Example cURL request to return the information associated with user ID 57:
curl -G -u graze:graze -k -v "https://localhost/graze/v1/getUserInfo" \ --data-urlencode "user_id=57"
Response example
Example response returning the user information related to user ID 57:
{ "full_name":"Lonnie Holmes","user_id":57 }