Core Data
/Attribute

Attribute

Attributes model data on top of Objects and Lists. Some Attributes, such as the name on a person, are system-defined while others are user-defined. Attributes are one of many types such as text, checkbox or currency.

List Attributes

Lists all Attributes defined on a specific Object or List. Attributes are returned in the order that they are sorted by in the UI.

Scopes

object_configuration:readrequired

Path params

targetenum

REQUIRED

Whether the Attributes are on an Object or a List.

Accepted values:"objects","lists"

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Attributes belong to.

Query params

limitinteger

The maximum number of results to return. See the full guide to pagination here.

offsetinteger

The number of results to skip over before returning. See the full guide to pagination here.

show_archivedboolean

Whether archived Attributes should be included in the results. See the full guide to archiving here.

Response

Status code

Description

Request

GET

/v2/:target/:identifier/attributes

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes?limit=10&offset=5&show_archived=true \
  -H "Authorization: Bearer <token>"

Response

200 - Success

{
  "data": [
    {
      "id": {
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
      },
      "type": "rating",
      "title": "Rating",
      "config": {
        "currency": {
          "display_type": null,
          "default_currency_code": null
        },
        "record_reference": {
          "allowed_object_ids": null
        }
      },
      "api_slug": "Rating",
      "is_unique": false,
      "created_at": "2021-11-21T13:22:49.061Z",
      "description": "Rating of the record out of 5",
      "is_archived": false,
      "is_required": false,
      "default_value": null,
      "is_multiselect": false,
      "is_system_attribute": false,
      "is_default_value_enabled": false
    }
  ]
}

Create an Attribute

Creates a new Attribute on either an Object or a List.

Scopes

list_configuration:read-writeoptional
object_configuration:read-writeoptional

Path params

targetenum

REQUIRED

Whether the Attribute is to be created on an Object or a List.

Accepted values:"objects","lists"

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Attribute belongs to.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

POST

/v2/:target/:identifier/attributes

curl https://api.attio.com/v2/lists/97052eb9-e65e-443f-a297-f2d9a4a7f795/attributes \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d @- << EOF
    {
      "data": {
        "type": "text",
        "title": "Your Attribute",
        "config": {
          "currency": {
            "display_type": "symbol",
            "default_currency_code": "USD"
          },
          "record_reference": {
            "allowed_objects": [
              "people"
            ]
          }
        },
        "api_slug": "my-attribute",
        "is_unique": true,
        "description": "Lorem ipsum",
        "is_required": true,
        "default_value": {
          "type": "static",
          "template": [
            {
              "value": 5
            }
          ]
        },
        "is_multiselect": true
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "type": "rating",
    "title": "Rating",
    "config": {
      "currency": {
        "display_type": null,
        "default_currency_code": null
      },
      "record_reference": {
        "allowed_object_ids": null
      }
    },
    "api_slug": "Rating",
    "is_unique": false,
    "created_at": "2021-11-21T13:22:49.061Z",
    "description": "Rating of the record out of 5",
    "is_archived": false,
    "is_required": false,
    "default_value": null,
    "is_multiselect": false,
    "is_system_attribute": false,
    "is_default_value_enabled": false
  }
}

Get an Attribute

Gets information about a single Attribute on either an Object or a List.

Scopes

object_configuration:readrequired

Path params

targetenum

REQUIRED

Whether the Attribute is on an Object or a List.

Accepted values:"objects","lists"

attributestring

REQUIRED

A UUID or slug to identify the Attribute.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Attribute belongs to.

Response

Status code

Description

Request

GET

/v2/:target/:identifier/attributes/:attribute

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96 \
  -H "Authorization: Bearer <token>"

Response

200 - Success

{
  "data": {
    "id": {
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "type": "rating",
    "title": "Rating",
    "config": {
      "currency": {
        "display_type": null,
        "default_currency_code": null
      },
      "record_reference": {
        "allowed_object_ids": null
      }
    },
    "api_slug": "Rating",
    "is_unique": false,
    "created_at": "2021-11-21T13:22:49.061Z",
    "description": "Rating of the record out of 5",
    "is_archived": false,
    "is_required": false,
    "default_value": null,
    "is_multiselect": false,
    "is_system_attribute": false,
    "is_default_value_enabled": false
  }
}

Update an Attribute

Updates a single Attribute on a given Object or List.

Scopes

object_configuration:read-writerequired

Path params

targetenum

REQUIRED

Whether the Attribute is on an Object or a List.

Accepted values:"objects","lists"

attributestring

REQUIRED

A UUID or slug to identify the Attribute.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Attribute belongs to.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

PATCH

/v2/:target/:identifier/attributes/:attribute

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -X PATCH \
  -d @- << EOF
    {
      "data": {
        "title": "Your Attribute",
        "config": {
          "currency": {
            "display_type": "symbol",
            "default_currency_code": "USD"
          },
          "record_reference": {
            "allowed_objects": [
              "people"
            ]
          }
        },
        "api_slug": "my-attribute",
        "description": "Lorem ipsum",
        "is_archived": false,
        "is_required": true,
        "default_value": {
          "type": "static",
          "template": [
            {
              "value": 5
            }
          ]
        }
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "type": "rating",
    "title": "Rating",
    "config": {
      "currency": {
        "display_type": null,
        "default_currency_code": null
      },
      "record_reference": {
        "allowed_object_ids": null
      }
    },
    "api_slug": "Rating",
    "is_unique": false,
    "created_at": "2021-11-21T13:22:49.061Z",
    "description": "Rating of the record out of 5",
    "is_archived": false,
    "is_required": false,
    "default_value": null,
    "is_multiselect": false,
    "is_system_attribute": false,
    "is_default_value_enabled": false
  }
}

List Select Options

Lists all Select Options for a particular Attribute on either an Object or a List.

Scopes

object_configuration:readrequired

Path params

targetenum

REQUIRED

Whether the Attribute is on an Object or a List.

Accepted values:"objects","lists"

attributestring

REQUIRED

A UUID or slug to identify the Attribute you want to list Select Options on.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Select Attribute belongs to.

Query params

show_archivedboolean

true if you want the results to include archived Select Options.

Response

Status code

Description

Request

GET

/v2/:target/:identifier/attributes/:attribute/options

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/options?show_archived=true \
  -H "Authorization: Bearer <token>"

Response

200 - Success

{
  "data": [
    {
      "id": {
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
        "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
      },
      "title": "Medium",
      "is_archived": false
    }
  ]
}

Create a Select Option

Adds a Select Option to a Select Attribute on an Object or a List.

Scopes

object_configuration:read-writerequired

Path params

targetenum

REQUIRED

Whether the Attribute is on an Object or a List.

Accepted values:"objects","lists"

attributestring

REQUIRED

A UUID or slug to identify the Attribute to create a Select Option on.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Select Attribute belongs to.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

POST

/v2/:target/:identifier/attributes/:attribute/options

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/options \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d @- << EOF
    {
      "data": {
        "title": "Medium"
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "title": "Medium",
    "is_archived": false
  }
}

Update a Select Option

Updates a Select Option on an Attribute on either an Object or a List.

Scopes

object_configuration:read-writerequired

Path params

optionstring

REQUIRED

A UUID or Select Option title to identify the Select Option you would like to update.

targetenum

REQUIRED

Whether the Attribute is on an Object or a List.

Accepted values:"objects","lists"

attributestring

REQUIRED

A UUID or slug to identify the Select Attribute.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Select Attribute belongs to.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

PATCH

/v2/:target/:identifier/attributes/:attribute/options/:option

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/options/Medium \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -X PATCH \
  -d @- << EOF
    {
      "data": {
        "title": "Medium",
        "is_archived": false
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "title": "Medium",
    "is_archived": false
  }
}

List Statuses

Lists all Statuses for a particular Status Attribute on either an Object or a List.

Scopes

object_configuration:readrequired

Path params

targetenum

REQUIRED

Whether the Attribute is on an Object or a List. Please note that the Company and People Objects do not support Status Attributes at this time.

Accepted values:"lists","objects"

attributestring

REQUIRED

A UUID or slug to identify the Attribute you want to list Statuses on.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Status Attribute belongs to.

Query params

show_archivedboolean

true if you want the results to include archived Statuses. See our Archiving guide for more information on archiving.

Response

Status code

Description

Request

GET

/v2/:target/:identifier/attributes/:attribute/statuses

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/statuses?show_archived=true \
  -H "Authorization: Bearer <token>"

Response

200 - Success

{
  "data": [
    {
      "id": {
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
        "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
      },
      "title": "In Progress",
      "is_archived": false,
      "celebration_enabled": false,
      "target_time_in_status": "P0Y0M1DT0H0M0S"
    }
  ]
}

Create a Status

Add a new Status to a Status Attribute on either an Object or a List.

Scopes

object_configuration:read-writerequired

Path params

targetenum

REQUIRED

Whether the Attribute is on an Object or a List. Please note that Company and Person Objects do not support Status Attributes at this time.

Accepted values:"lists","objects"

attributestring

REQUIRED

A UUID or slug to identify the Attribute the status will belong to.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Status Attribute belongs to.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

POST

/v2/:target/:identifier/attributes/:attribute/statuses

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/statuses \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d @- << EOF
    {
      "data": {
        "title": "In Progress",
        "celebration_enabled": true,
        "target_time_in_status": "P0Y0M1DT0H0M0S"
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "title": "In Progress",
    "is_archived": false,
    "celebration_enabled": false,
    "target_time_in_status": "P0Y0M1DT0H0M0S"
  }
}

Update a Status

Update a Status on an Status Attribute on either an Object or a List.

Scopes

object_configuration:read-writerequired

Path params

statusstring

REQUIRED

A UUID or Status title to identify the Status to update.

targetenum

REQUIRED

Whether the Attribute is on an Object or a List. Please note that Company and Person Objects do not support Status Attributes at this time.

Accepted values:"lists","objects"

attributestring

REQUIRED

A UUID or slug to identify the Attribute to update the Status on.

identifierstring

REQUIRED

A UUID or slug to identify the Object or List the Status Attribute belongs to.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

PATCH

/v2/:target/:identifier/attributes/:attribute/statuses/:status

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/statuses/In Progress \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -X PATCH \
  -d @- << EOF
    {
      "data": {
        "title": "In Progress",
        "is_archived": false,
        "celebration_enabled": true,
        "target_time_in_status": "P0Y0M1DT0H0M0S"
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "title": "In Progress",
    "is_archived": false,
    "celebration_enabled": false,
    "target_time_in_status": "P0Y0M1DT0H0M0S"
  }
}

Terms & conditions Privacy policy Security

Standard Objects

Core Data

Note

Task

Workspace Members

Webhooks

Reference

Help

Attribute

List Attributes

Scopes

Path params

Query params

Response

200Success

Request

Response

Create an Attribute

Scopes

Path params

Request Body

Response

200Success

400Bad Request

404Not Found

409Conflict

Request

Response

Get an Attribute

Scopes

Path params

Response

200Success

404Not Found

Request

Response

Update an Attribute

Scopes

Path params

Request Body

Response

200Success

400Bad Request

404Not Found

Request

Response

List Select Options

Scopes

Path params

Query params

Response

200Success

404Not Found

Request

Response

Create a Select Option

Scopes

Path params

Request Body

Response

200Success

400Bad Request

404Not Found

409Conflict

Request

Response

Update a Select Option

Scopes

Path params

Request Body

Response

200Success

400Bad Request

404Not Found

409Conflict

Request

Response

List Statuses

Scopes

Path params