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...

Organizations / Organization Get Info

  • Article
  • 3 minutes to read

Operation Information

Retrieves information about a Pipedrive Organization.

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
Organization Id orgId number None provided Yes None provided

Output Parameters

Display Name ID Type Description
Active Flag active_flag boolean None provided
Activities Count activities_count number None provided
Add Time add_time string None provided
Address address string None provided
Address Admin Area Level 1 address_admin_area_level_1 string None provided
Address Admin Area Level 2 address_admin_area_level_2 string None provided
Address Country address_country string None provided
Address Formatted address_formatted_address string None provided
Address Locality address_locality string None provided
Address Post Code address_postal_code string None provided
Address Route address_route string None provided
Address Street Number address_street_number string None provided
Address Sublocality address_sublocality string None provided
Address Subpremise address_subpremise string None provided
Category ID category_id number None provided
Closed Deals Count closed_deals_count string None provided
Company ID company_id number None provided
Country Code country_code string None provided
Done Activities Count done_activities_count number None provided
Files Count files_count number None provided
Followers Count followers_count number None provided
Lost Deals Count lost_deals_count number None provided
Name name string None provided
Notes Count notes_count number None provided
Open Deals Count open_deals_count number None provided
Email owner_email string None provided
Owner ID owner_id number None provided
Name owner_name string None provided
People Count people_count number None provided
Undone Activities Count undone_activities_count number None provided
Update Time update_time string None provided
Visibile To visible_to number None provided
Won Deals Count won_deals_count number None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document