A list of all data attributes belonging to a workspace for contacts, companies or conversations.
typestringrequired
The type of the object
Value"list"
Example: "list"
dataArray of objects(Data Attribute)required
A list of data attributes
data[].typestringrequired
Value is data_attribute.
Value"data_attribute"
Example: "data_attribute"
data[].idinteger
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
Example: 12878
data[].modelstring
Value is contact for user/lead attributes and company for company attributes.
Enum"contact""company"
Example: "contact"
data[].namestringrequired
Name of the attribute.
Example: "paid_subscriber"
data[].full_namestringrequired
Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.
Example: "custom_attributes.paid_subscriber"
data[].labelstringrequired
Readable name of the attribute (i.e. name you see in the UI)
Example: "Paid Subscriber"
data[].descriptionstringrequired
Readable description of the attribute.
Example: "Whether the user is a paid subscriber."
data[].data_typestringrequired
The data type of the attribute.
Enum"string""integer""float""boolean""date"
Example: "boolean"
data[].optionsArray of strings
List of predefined options for attribute value.
Example: ["true","false"]
data[].api_writableboolean
Can this attribute be updated through API
Example: true
data[].messenger_writableboolean
Can this attribute be updated by the Messenger
Example: false
data[].ui_writableboolean
Can this attribute be updated in the UI
Example: true
data[].customboolean
Set to true if this is a CDA
Example: true
data[].archivedboolean
Is this attribute archived. (Only applicable to CDAs)
Example: false
data[].created_atinteger(date-time)
The time the attribute was created as a UTC Unix timestamp
Example: 1671028894
data[].updated_atinteger(date-time)
The time the attribute was last updated as a UTC Unix timestamp
Example: 1671028894
data[].admin_idstring
Teammate who created the attribute. Only applicable to CDAs
Example: "5712945"
{
"type": "list",
"data": [
{ … }
]
}
Data Event List
This will return a list of data events for the App.
typestringrequired
The type of the object
Value"event.list"
Example: "event.list"
eventsArray of objects(Data Event)required
A list of data events
events[].typestring
The type of the object
Value"event"
Example: "event"
events[].event_namestringrequired
The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.
Example: "invited-friend"
events[].created_atinteger(date-time)required
The time the event occurred as a UTC Unix timestamp
Example: 1671028894
events[].user_idstring
Your identifier for the user.
Example: "314159"
events[].idstring
Your identifier for a lead or a user.
Example: "8a88a590-e1c3-41e2-a502-e0649dbf721c"
events[].intercom_user_idstring
The Intercom identifier for the user.
Example: "63a0979a5eeebeaf28dd56ba"
events[].emailstring
An email address for your user. An email should only be used where your application uses email to uniquely identify users.