Entities
The entities
table contains data about entities in the organization.
This table can be used to determine what entities exist and their basic information, as well as metadata about the entity such as when it was created.
Columns
Column Name | Description | Type | Nullable |
---|---|---|---|
id | The numerical identifier of the object. | INT8 | No |
first_name | The first name of the entity. For entities with only one name field (ie. non-people entities), their name. | VARCHAR | No |
nickname | The nickname of the entity. | VARCHAR | Yes |
middle_name | The middle name of the entity. | VARCHAR | Yes |
last_name | The last name of the entity. | VARCHAR | Yes |
date_of_birth | The date of birth of the entity. | DATE | Yes |
preferred_language | The preferred language of the entity, in two character ISO 639 format. | VARCHAR | Yes |
organization_id | This column is deprecated and unused. | VARCHAR | Yes |
custom_id | This column is deprecated and unused. | VARCHAR | Yes |
dw_id | This column is deprecated and unused. | VARCHAR | Yes |
voterbase_id | This column is deprecated and unused. | VARCHAR | Yes |
linked_user_id | The numerical identifier of the user this entity was linked to when the entity was "promoted" to a user via the user interface. Relates to the id column in the users table. |
INT8 | Yes |
created_by_id | The numerical identifier of the user that created this entity. Relates to the id column in the users table. An ID of 1 typically means a machine-created address, such as over the API. |
INT8 | No |
created_at | The UTC timestamp when this object was created. | TIMESTAMP | No |
updated_at | The UTC timestamp when this object was last updated. | TIMESTAMP | No |
interact_id | The internal unique identifier for this entity for matching on the API, uploads, etc... | UUID | Yes |
age | The age of the entity. | INT4 | Yes |
calculated_birth_date | Whether the date_of_birth field was calculated based on age or not. | BOOL | Yes |
custom_id_1 | This column is deprecated and unused. | VARCHAR | Yes |
custom_id_2 | This column is deprecated and unused. | VARCHAR | Yes |
custom_id_3 | This column is deprecated and unused. | VARCHAR | Yes |
custom_id_4 | This column is deprecated and unused. | VARCHAR | Yes |
updated_by_id | The numerical identifier of the user that updated this entity. Relates to the id column in the users table. An ID of 1 typically means a machine-created address, such as over the API. |
INT8 | Yes |
entity_type_id | The numerical identifier of the entity type for this entity. Relates to the id column in the entity_types table. |
INT8 | Yes |
pronouns | This pronouns for this entity. | VARCHAR | Yes |