Entity Types
The entity_types
table contains data about types of entities present in the organization.
This table can be used to determine which types exist, as well as metadata about the type such as when it was created.
Columns
Column Name | Description | Type | Nullable |
---|---|---|---|
id | The numerical identifier of the object. | INT8 | No |
name_singular | The singular name of the entity type (ie. person), as displayed in the user interface. | VARCHAR | No |
name_plural | The singular name of the entity type (ie. people), as displayed in the user interface. | VARCHAR | No |
name_type | Whether entities of this type use a single name (ie. Bob's Shop) or a human name (ie. Robert "Bob" Smith). 0 for single name, 1 for human name. |
INT4 | No |
date_of_birth_enabled | Whether entities of this type have the date of birth and age fields available. | BOOL | Yes |
language_enabled | Whether entities of this type have the preferred language field available. | BOOL | Yes |
email_enabled | Whether entities of this type have email address fields available. | BOOL | Yes |
address_enabled | Whether entities of this type have postal address fields available. | BOOL | Yes |
phone_number_enabled | Whether entities of this type have phone number fields available. | BOOL | Yes |
created_at | The UTC timestamp when this object was created. | TIMESTAMP | No |
updated_at | The UTC timestamp when this object was updated. | TIMESTAMP | No |
interact_id | The internal unique identifier for this entity type. | UUID | No |
icon | The name of the icon used for this entity type. | VARCHAR | Yes |
social_enabled | Whether entities of this type have social fields available. | BOOL | Yes |
pronouns_enabled | Whether entities of this type have the preferred pronoun field available. | BOOL | Yes |