Attribute properties
In the API, attributes are presented as a set of properties. Some attribute types have specific properties (e.g. an actor reference attribute has thereferenced_actor_type
property), but all attributes have the following properties:
id
, which is a composite ID composed of(workspace_id, object_id, attribute_id)
title
, the human-readable name of the attribute (e.g."Name"
)description
, an optional human-readable description (e.g."The name as registered in our database"
)api_slug
, a shorthand way for developers to refer to this attribute (e.g."name"
)type
, one of the enumerated types below (e.g."text"
)is_archived
, whether the attribute has been archivedis_required
, whether a value is required when creating the record or list entryis_unique
, whether the value for this attribute is unique among all other records or list entries of that typeis_multiselect
, whether you can write more than one value to this attributeis_default_value_enabled
anddefault_value
, see the default values guidecreated_at
, a timestamp of when this attribute was first createdconfig
, an object containing specific configuration forcurrency
orrecord_reference
types
Attribute values
Attribute values represent the value of the given attribute on a given record or list entry. They also have a set of common properties, that you’ll see referenced throughout this guide:active_from
, a timestamp showing when this value was createdactive_until
, either a timestamp (meaning the value was readable until that point in time) ornull
, meaning the value is still currently active. Most endpoints will only return active values, meaning this value is usuallynull
. In special cases, such as the list record attribute values API, you can also query historic data.created_by_actor
, a reference to theid
andtype
of the Actor who created this valueattribute_type
, matches thetype
property on the Attribute itself (e.g."text"
)