API IDs
Nutshell uses identifiers to refer to various entities
API IDs for different entity types
In Nutshell's JSON-RPC API, and in some URLs, you will notice that Nutshell uses integers to refer to entities. For example, https://app.nutshell.com/person/1-andy-fowler will refer to person #1.
In many APIs, Nutshell uses what we refer to as API IDs which look like 7-contacts or 35-users or 7-activities. These identifiers make it easier to handle polymorphic entities. For example, an activity might have 3 participants 3-users, 5-contacts and 5-users.
When possible, we allow API clients to interchange simple integer entity ID (3) with their API IDs (3-users). We recommend using the API ID whenever possible.
Note that lead numbers are not the same as lead IDs!Nutshell uses user-facing lead numbers, to make it easy to refer to specific prospects. These numbers are visible in the UI and often look like Lead-1001. Note that lead numbers are not the same as a lead ID. If you look at a lead object in our API, you will see both a number and an id attribute.
This is because numbers are guaranteed to be serial and incremental.
Updated 7 months ago