Get an attribute

Authorizations

Authorization

string

header

required

This API uses OAuth 2.0 with the authorization code grant flow.

Path Parameters

target

enum<string>

required

Whether the attribute is on an object or a list.

Available options:

objects,

lists

Example:

"lists"

identifier

string

required

A UUID or slug to identify the object or list the attribute belongs to.

Example:

"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"

attribute

string

required

A UUID or slug to identify the attribute.

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

Response

Success

data

object

required

Show child attributes

data.id

object

required

Show child attributes

data.id.workspace_id

string<uuid>

required

A UUID representing the workspace this attribute belongs to.

Example:

"14beef7a-99f7-4534-a87e-70b564330a4c"

data.id.object_id

string<uuid>

required

A UUID to identify the object or list that this attribute belongs to

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.id.attribute_id

string<uuid>

required

A UUID to identify this attribute.

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

data.title

string

required

A title for the attribute, to be displayed across the app.

Example:

"Company"

data.description

string | null

required

A text description of the attribute.

Example:

"A company attribute"

data.api_slug

string

required

A unique slug for the attribute for use in API responses and URLs. Formatted in snake case.

Example:

"company"

data.type

enum<string>

required

The type of the attribute.

Available options:

text,

number,

checkbox,

currency,

date,

timestamp,

rating,

status,

select,

record-reference,

actor-reference,

location,

domain,

email-address,

phone-number,

interaction,

personal-name

Example:

"text"

data.is_system_attribute

boolean

required

true if this is an Attio system-defined attribute, false if defined by a user or non-Attio system.

Example:

true

data.is_writable

boolean

required

Whether or not this attribute can be written to. Can only be false when is_system_attribute is true (user-defined attributes are always writeable). If false, this usually means the attribute is enriched by Attio.

Example:

true

data.is_required

boolean

required

When is_required is true, new records/entries must have a value for this attribute. If false, values may be null. This value does not affect existing data and you do not need to backfill null values if changing is_required from false to true.

Example:

true

data.is_unique

boolean

required

Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data.

Example:

true

data.is_multiselect

boolean

required

Whether or not this attribute can have multiple values. Multiselect is only available on some value types.

Example:

true

data.is_default_value_enabled

boolean

required

Whether this attribute has a default value enabled. Must be true when is_required is true.

Example:

true

data.is_archived

boolean

required

Whether this attribute has been archived. Archived attributes are hidden from most UI, but can be restored either over the API or in workspace settings. See the guide on archiving and deletingfor more information.

Example:

false

data.default_value

object

required

The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute.

Option 1
Option 2

Show child attributes

data.default_value.type

enum<string>

required

Available options:

dynamic

Example:

"dynamic"

data.default_value.template

required

For actor reference attributes, you may pass a dynamic value of "current-user". When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry.

Available options:

current-user

Example:

"current-user"

data.relationship

object

required

If this attribute is related to another attribute, this is an object that includes an id property that identifies the other attribute. null means no relationship exists. See the help center for more details about relationship attributes.

Show child attributes

data.relationship.id

object

required

Show child attributes

data.relationship.id.workspace_id

string<uuid>

required

A UUID representing the workspace this attribute belongs to.

Example:

"14beef7a-99f7-4534-a87e-70b564330a4c"

data.relationship.id.object_id

string<uuid>

required

A UUID to identify the object or list that this attribute belongs to

Example:

"97052eb9-e65e-443f-a297-f2d9a4a7f795"

data.relationship.id.attribute_id

string<uuid>

required

A UUID to identify this attribute.

Example:

"41252299-f8c7-4b5e-99c9-4ff8321d2f96"

data.relationship.object_slug

string

required

The slug of the object that the related attribute belongs to.

Example:

"companies"

data.relationship.title

string

required

The title of the related attribute.

Example:

"Team members"

data.relationship.api_slug

string

required

The API slug identifying the related attribute.

Example:

"team_members"

data.relationship.is_multiselect

boolean

required

Whether the related attribute supports selecting multiple values. Combined with the parent attribute's is_multiselect, this determines the relationship type: both false = one-to-one, parent true + related false = many-to-one, parent false + related true = one-to-many, both true = many-to-many.

Example:

true

data.created_at

string

required

When this attribute was created.

Example:

"2022-11-21T13:22:49.061281000Z"

data.config

object

required

Additional, type-dependent configuration for the attribute.

Show child attributes

data.config.currency

object

required

Configuration available for attributes of type "currency".

Show child attributes

data.config.currency.default_currency_code

enum<string> | null

required

The ISO4217 code representing the currency that values for this attribute should be stored in.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CLP,

CNY,

COP,

CZK,

DKK,

EUR,

HKD,

ISK,

INR,

ILS,

JPY,

KRW,

MYR,

MXN,

NTD,

NZD,

NGN,

NOK,

XPF,

PEN,

PHP,

PLN,

GBP,

RWF,

SAR,

SGD,

ZAR,

SEK,

CHF,

THB,

AED,

UYU,

USD

Example:

"USD"

data.config.currency.display_type

enum<string> | null

required

How the currency should be displayed across the app. "code" will display the ISO currency code e.g. "USD", "name" will display the localized currency name e.g. "British pound", "narrowSymbol" will display "$1" instead of "US$1" and "symbol" will display a localized currency symbol such as "$".

Available options:

code,

name,

narrowSymbol,

symbol

Example:

"code"

data.config.record_reference

object

required

Configuration available for attributes of type "record-reference".

Show child attributes

data.config.record_reference.allowed_object_ids

string<uuid>[] | null

required

A list of UUIDs to indicate which objects records are allowed to belong to. Leave empty to to allow records from all object types.

Example:

{
  "id": {
    "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
    "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
    "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
  },
  "title": "Company",
  "description": "A company attribute",
  "api_slug": "company",
  "type": "record-reference",
  "is_system_attribute": false,
  "is_writable": true,
  "is_required": false,
  "is_unique": false,
  "is_multiselect": false,
  "is_default_value_enabled": false,
  "is_archived": false,
  "default_value": null,
  "relationship": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
    },
    "object_slug": "companies",
    "title": "Team members",
    "api_slug": "team_members",
    "is_multiselect": true
  },
  "created_at": "2021-11-21T13:22:49.061Z",
  "config": {
    "currency": {
      "default_currency_code": null,
      "display_type": null
    },
    "record_reference": { "allowed_object_ids": ["companies"] }
  }
}

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

Authorizations

Path Parameters

Response