Retrieving information about the current user

Introduced in 8.5

Description

The API provides the ability to obtain information about the currently logged in user. This method retrieves all data of the Person record fields from the database.

HTTP method

GET

API URL

http://www.example.com/api/v2/profile

URL parameters

No parameters required for this request.

Response Format

The server returns field values of the requested Person in the Items array.

{
	"success": true,
	"errorCode": 0,
	"errorText": "",
	"responseObject": {
		"Items": [
		{
			"name": "<field name>",
			"caption": "<field caption(Label)>",
			"value": "<field value>"
		},
		//...
		]
	}
}

Property	Description	Format
Items	The list of retrieved data fields with values.	Array
name	The field name.	String
caption	The field caption.	String
value	The field value.	String

Example

Here is an example of how you can query Person data.

Request:

(GET) http://www.example.com/api/v2/profile

Response:

{
	"success": true,
	"errorCode": 0,
	"errorText": "",
	"responseObject": {
		"Items": [
		{
			"name": "ID",
			"caption": "ID",
			"value": "{5AF47F04-A4A4-4ED2-9B65-0D004345806E}""
		},
		{
			"name": "Technician",
			"caption": "Technician",
			"value": "1"
		},
		{
			"name": "First_Name",
			"caption": "First Name",
			"value": "Maxwell"
		},
		{
			"name": "Last_Name",
			"caption": "Last Name",
			"value": "Newcomb"
		},
		{
			"name": "Gender",
			"caption": "Gender",
			"value": "Male"
		},
		{
			"name": "Organization",
			"caption": "Organization",
			"value":"Acme, Inc.\\Information Technology"
		},
		{
			"name": "Available_Now",
			"caption": "Available_Now",
			"value": "No"
		},
		{
			"name": "Address",
			"caption": "Address",
			"value": "199 Acme Ave.\nBoogeytown, New Jersey 07999\nUSA"
		},
		//...
		]
	}
}