v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Data Attributes

List all data attributes

You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.

get/data_attributes

Query parameters

model'contact' | 'company' | 'conversation'

Specify the data attribute model to return.

include_archivedboolean

Include archived attributes in the list. By default we return only non archived data attributes.

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

Successful response

type'list'

The type of the object

Example response

{
  "type": "list",
  "data": [
    {
      "type": "data_attribute",
      "id": 12878,
      "model": "contact",
      "name": "paid_subscriber",
      "full_name": "custom_attributes.paid_subscriber",
      "label": "Paid Subscriber",
      "description": "Whether the user is a paid subscriber.",
      "data_type": "boolean",
      "options": [
        "true",
        "false"
      ],
      "api_writable": true,
      "ui_writable": true,
      "custom": true,
      "created_at": 1671028894,
      "updated_at": 1671028894,
      "admin_id": "5712945"
    }
  ]
}