Intercom API (unofficial showcase)
GET/data_attributes

List data attributes

Lists workspace data attributes for contacts or companies. Use model to select a model and include_archived to include archived attributes; conversation attributes are available from GET /conversations/attributes instead.

3 parameters
modelstringoptional
The attribute model to return: `contact` or `company`. Use `GET /conversations/attributes` for conversation attributes.
Allowed:contactcompany
include_archivedbooleanoptional
Whether to include archived attributes. Defaults to false when omitted.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; use a supported version.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a list of workspace data attributes for contacts or companies.
typestringoptional
The type of the object
Allowed:list
dataarray<DataAttribute>optional
A list of data attributes
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when `model=conversation` is supplied, because conversation attributes are no longer supported by this operation.

One documented failure

  • parameter_invalid

    model=conversation is no longer supported. Use GET /conversations/attributes instead

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized, and a 422 is returned when model=conversation is supplied because conversation attributes are not supported by this operation. model must be contact or company when provided.