Home > Application Reference > Pipedrive > Search Record by Term

Search Record by Term

Outputs all data on the first record that is found with the given term. NOTE: Not all search terms will return a result. We suggest using a search term that is unique to the record, such as email address for a contact.

Options

  • Your pipedrive entities (dropdown): a dropdown of your available record types to update in Pipedrive including deals, contacts and organizations

  InputFields

  • term (text): the term by which you want to find a record in Pipedrive. This field is required. NOTE: Not all search terms will return a result.  For example, if you search by a date, no records will be found. We suggest using a search term that is unique to the record, such as an email address for a contact.

OutputFields

Output fields are dynamically generated and will reflect the fields that are available in your Pipedrive instance for the record type that was found. NOTE: all custom fields are represented by a unique ID string. For tips on how to work with custom fields on cards, please see the Custom Fields section below.

  • id (number): the unique identifier of the record that was found in Pipedrive. NOTE: ID will be returned for all records and can be used to read a record using Search by ID or to update a record using Update.

Custom Fields

Custom fields that you have created in Pipedrive for any record type will be represented as a unique ID string. Follow these steps to find the text label for the custom field:

  1. Go to Settings
  2. Click “Custom Fields”
  3. Select the record type: Deal, Contact, Organization or Activity
  4. Scan for the custom field unique ID string that matches the Field API Key in Pipedrive. The Field Name can then be found to the left of the Field API Key column that matches what you see.

You can then rename the field in the card in your Flow to match the text label:

  1. Hover over the card within your Flow on which you wish to rename a field
  2. Click the cog icon on the bottom of the card
  3. Click the pencil icon next to the field you are renaming
  4. Type in a new Display Name
  5. Click Save

If your custom field is formatted as single option, the field will only take in certain values, each one of which is identified as a unique ID. Therefore, when writing to a custom, single option field in Pipedrive, you will need to enter in the ID of the option into that custom field, NOT the display name you see in Pipedrive.

For example, let’s say you have a single option custom field labeled “Lead Source” on a Pipedrive contact with a Field API Key of 12309fojpiawef123dr12s3jf978 and dropdown options of “Outbound” and “Inbound”. The options “Outbound” and “Inbound” will be assigned an ID automatically through the Pipedrive API, let’s say 121 for “Outbound” and 122 for “Inbound”. When you are creating a contact in Pipedrive via a Flow that came through an inbound lead source, you would type 122 into the field 12309fojpiawef123dr12s3jf978 on the Pipedrive Create card.

How do you know where to find the ID of the dropdown options?

To find the ID of the single options, you need to go to Pipedrive’s API documentation. Don’t be intimidated though, you don’t need to be an engineer to follow these steps:

  1. Go to Settings.
  2. Click the Personal category and then API.
  3. Copy your personal API token.
  4. Visit this link: https://developers.pipedrive.com/v1. This is Pipedrive’s API documentation.
  5. Scroll down until you see the header “The API endpoints & live testing”. Paste your personal API token into the box labeled “Type in your API token for live testing”.
  6. Scroll down until you find the record type on which you need to find the dropdown IDs. NOTE: “Contacts” are called “Persons” in the API documentation.
  7. Click the GET button next to the “Get all xxxx fields” button. For example, if you are looking for the dropdown ID of a custom field on a Contact, click the GET button next to the box labeled “Get all person fields”.
  8. Hit “Try it!”
  9. Either scroll to find the name of the custom field you are searching for or hit control F on your keyboard to search for the field.
  10. Once you find the custom field, you’ll notice first of all that the “key” above the field name is the Field API Key that you found before. Below the “options” header, you’ll see a list of the possible options on that field. The “id” is the number you need to type into the field. The “label” is the human-readable text you see when you are in Pipedrive.

From the Lead Source example above, you would see something like this in Pipedrive’s API documentation (important information in bold):

“id”: 1234,
“key”: “12309fojpiawef123dr12s3jf978”, “name”: “Lead Source”, “order_nr”: 9, “field_type”: “enum”, “add_time”: “2016-04-22 23:21:57”, “update_time”: “2016-07-05 15:25:50”, “active_flag”: true, “edit_flag”: true, “index_visible_flag”: true, “details_visible_flag”: true, “add_visible_flag”: true, “important_flag”: false, “bulk_edit_allowed”: true, “options”: [ { “id”: 121, “label”: “Outbound” }, { “id”: 122, “label”: “Inbound” …

Again, type 122 into the field in the card in order to select Inbound as your Contact’s Lead Source.

What about multiple option custom fields?

If you have a custom field that can take in multiple options, follow the same steps above. Then, when entering the option ID into the field in the card, separate each value by a comma and no spaces. For example, if Lead Source was a multiple option field and you wanted to make the Contact’s Lead Source both Inbound AND Outbound, you would type 121,122 into the Lead Source field.