Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The getUser operation retrieves data about a specific user within the company.

Code Block
languagexml
titlegetUser
<pipedrive.getUser>
    <id>{$ctx:id}</id>
    <prettyOutput>{$ctx:prettyOutput}</prettyOutput>
	<fields>{$ctx:fields}</fields>
</pipedrive.getUser>
Properties
  • id: The unique identifier for a user.
  • prettyOutput: If the prettyOutput is specified as 1, will return an indented response of the output.
  • fields: The array of fields to be returned in the output.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getUser operation.

Code Block
languagexml
titleSample Request for getUser
{
	"apiToken":"7ccee3fe30e479ae845169ec8601ba8b4ab2be0d",
	"apiUrl":"https://api.pipedrive.com",
	"id":589352,
	"prettyOutput":1,
	"fields":["id","name","email"]
}
Related Pipedrive documentation

https://developers.pipedrive.com/v1#methods-Users

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

Following is a sample proxy service that illustrates how to connect to Pipedrive with the init operation and use the getUser operation. The sample request for this proxy can be found in the getUser sample request.

Code Block
languagexml
titleSample Proxy
<?xml version="1.0" encoding="UTF-8"?>
	<proxy xmlns="http://ws.apache.org/ns/synapse" name="pipedrive_getUser" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
	 <target>
	 <inSequence>
      <property name="apiToken" expression="json-eval($.apiToken)"/>
      <property name="apiUrl" expression="json-eval($.apiUrl)"/>
      <property name="id" expression="json-eval($.id)"/>
      <property name="prettyOutput" expression="json-eval($.prettyOutput)"/>
      <property name="fields" expression="json-eval($.fields)"/>
      <pipedrive.init>
         <apiToken>{$ctx:apiToken}</apiToken>
         <apiUrl>{$ctx:apiUrl}</apiUrl>
      </pipedrive.init>
      <pipedrive.getUser>
         <id>{$ctx:id}</id>
         <prettyOutput>{$ctx:prettyOutput}</prettyOutput>
         <fields>{$ctx:fields}</fields>
      </pipedrive.getUser>
	   <respond/>
	 </inSequence>
	  <outSequence>
	   <send/>
	  </outSequence>
	 </target>
   <description/>
  </proxy>