Skip to content
Home/
/Conversations Attributes

List all conversation attributes

Request

You can fetch a list of all conversation attributes for your workspace.

Security
bearerAuth
Query
include_archivedboolean

Include archived attributes in the list. Default false.

Example:include_archived=false
Headers
Intercom-Versionstring(intercom_version)

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

Default:"2.16"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.16
require 'uri'
require 'net/http'
require 'openssl'

url = URI('https://api.intercom.io/conversations/attributes')
params = {
  include_archived: 'false'
}
url.query = URI.encode_www_form(params)

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Intercom-Version'] = '2.16'
request['Authorization'] = 'Bearer <YOUR_TOKEN_HERE>'

response = http.request(request)
puts response.read_body

Responses

Successful response

Bodyapplication/json
typestring

The type of the object.

Value:"list"
Example:"list"
dataArray of any(Conversation Attribute)

A list of conversation attributes.

Response
{
  "type": "list",
  "data": [
    { … },
    { … },
    { … }
  ]
}