Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Persons / Person Get Info

  • Article
  • 2 minutes to read

Operation Information

Retrieves information about a Pipedrive Person.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type API Key.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint

Tip

The API Endpoint field is not required to be populated for this integration - just an API Key for your Pipedrive account.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked API Key account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Person Id personId number ID of the Person Yes None provided

Output Parameters

Display Name ID Type Description
Activated? activated boolean Is the Person activated?
Active Flag active_flag boolean Does the user have an active flag
Company ID company_id number The company ID associated to the Person
Created created string When the Person was created
Default Currency default_currency string The default currency of the user
Email email string The email address of the user
Has Created Company has_created_company boolean True / False have they created a company
Icon URL icon_url string Icon URL
User ID id number The User ID of the Person
Admin? is_admin number Is the Person an administrator?
Is You? is_you boolean Is this request for the user sending the request
Lang lang number The language of the Person
Last Login last_login string The last login of the Person
Locale locale string The locale of the Person
Modified modified string The last modified time of the user
Name name string The name of the Person
Phone phone string The phone number of the Person
Role ID role_id string The role ID of the Person
Signup Flow Variation signup_flow_variation string Signup Flow Variation
Timezone Name timezone_name string The timezone name of the Person’s timezone
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document