What is Extern Key?

The field External Key can hold an id or similar  value that exists in another system.

When the field is in place it is exposed in our api and you can use it in there or in Zapier to find types in Lime Go.

How do you create an External Key?

Deals, companies and persons can have a custom field that is of the type External Key. Go to Settings > Deals|Companies|Persons > Custom fields.

The field must have a unique value per type (Deals, Companies or Persons). Meaning the same value can exists on both a deal and a company but two different companies can't have the same value.


Lets say you have a customer id for a company in a external system that you need to store on the corresponding company in Lime Go.

  1. Go to Settings > Companies > Custom fields and click on + Add... Give the field a name i.e. MySystem and select the type External Key from the drop down.
  2. Go to a company in Lime Go and click Edit. You'll find the newly created field under the section Custom fields. You can set the value manually or you can use our api to update the field value.
Was this article helpful?
0 out of 0 found this helpful


Article is closed for comments.