Employee
The primary entity. Covers identity, employment, compensation, organisational structure, and more.
Organizational Unit
Nodes in a company’s structure - departments, divisions, teams, and similar.
Project
Project entities. Supported in Twine but not yet available through the public API.
Customer
Customer entities. Supported in Twine but not yet available through the public API.
Competence
Skills, certificates and licences, and the assignments that give them to employees.
Dated Properties
Every property on a Twine entity is represented as an array of Dated Properties, sorted in descending order byvalid_from. This means the most recently effective value is always first in the list.
Each dated property has three fields:
Example
Asalary_amount history might look like this:
null value entry on 2021-01-01 signals that the salary ended on 2020-12-31.
Properties with multiple simultaneous values
When a property can hold more than one value at the same time - such as cost centre allocations or benefits - theid field segments them. Each distinct id represents an independent value series, with its own history:
List properties
Some properties hold an array as their value rather than a scalar - for example,team_id, which lists all teams an employee belongs to. These behave identically to scalar dated properties, except that value is an array.
A rework of how certain list properties are modelled is currently being evaluated. This may affect how values are stored and tracked for properties such as
team_id.Dated property patterns
A compact string format for encoding multiple date-tracked values into a single text field - used when a source system cannot represent dated values natively.
Custom Properties
Every entity supports acustom_properties map. Each key in the map is a property name defined by the customer, and its value is an array of dated properties following the same structure as built-in properties - including support for the id discriminator.
Custom properties are used when Twine’s built-in property set does not cover a field that a customer needs to transfer. They behave identically to built-in properties in the Data Engine and in domain mappings.
Computed Properties
Some properties are automatically derived from other properties unless you explicitly map them yourself. For example,manager_id is resolved from source_external_manager_id - Twine looks up the employee whose source_external_id matches the value in source_external_manager_id and populates manager_id with their Twine UUID.
If you provide an explicit mapping for a computed property, the automatic derivation is skipped entirely and your mapping takes precedence.
Source Properties
Properties prefixed withsource_ (such as source_external_id and source_organizational_unit_external_ids) are internal tracking fields that Twine uses to maintain references back to records in the originating system. They are exposed in the API but should not be relied upon for business logic if a more semantically meaningful property exists. Use them only when no suitable alternative is available.
The most important source property is source_external_id. It must always be mapped to the primary key of the entity in the remote system. Twine relies on it to identify and match records across syncs, and computed properties like manager_id depend on it being present and correct.