ATattio
Attributes

List attributes

Changed on

Lists all attributes defined on a specific object, list or activity. Attributes are returned in the order that they are sorted by in the UI.

When target is objects, the required scopes are object_configuration:read. When target is lists, the required scopes are list_configuration:read. When target is activities, the required scopes are activity_configuration:read.

Supported token levels: workspace, user.

get/v2/{target}/{identifier}/attributes

Request

  • Base URL
    https://api.attio.com
  • URL
    https://api.attio.com/v2/{target}/{identifier}/attributes
  • Auth
    OAuth 2
    Authorization code: https://app.attio.com/authorize
    Token URL: https://app.attio.com/oauth/token

Path parameters

target'objects' | 'lists' | 'activities' required

Whether the attributes are on an object, a list or an activity.

Example:lists
identifierstring required

A UUID or slug to identify the object, list or activity the attributes belong to.

Example:33ebdbe9-e529-47c9-b894-0ba25e9c15c0

Query parameters

limitinteger

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

Example:10
offsetinteger

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

Example:5
show_archivedboolean

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

Example:true

Response

Success

Example response

{
  "data": [
    {
      "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"
          ]
        }
      }
    }
  ]
}

Changes

  • 81e667ad2d75Revision changes
    • info

      added the new enum value activities to the path request parameter target

  • 512a93f0f5edRevision changes
    • info

      removed the call enum value from the /////// response property for the response status

    • info

      removed the chat-thread enum value from the /////// response property for the response status

    • info

      removed the in-person-meeting enum value from the /////// response property for the response status