Ticket part author

Ticket List

Tickets are how you track requests from your users.

typestringrequired

Always ticket.list

Value"ticket.list"

Example: "ticket.list"

ticketsArray of objects(Ticket)required

The list of ticket objects

tickets[].typestringrequired

Always ticket

Default "ticket"

Value"ticket"

Example: "ticket"

tickets[].idstringrequired

The unique identifier for the ticket which is given by Intercom.

Example: "1295"

tickets[].ticket_idstringrequired

The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.

Example: "1390"

tickets[].categorystringrequired

Category of the Ticket.

Enum"Customer""Back-office""Tracker"

Example: "Customer"

tickets[].ticket_attributesobject(Ticket Attributes)required

An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are _default_title_ and _default_description_.

Example: {"_default_title_":"Found a bug","_default_description_":"The button's not working"}

tickets[].ticket_attributes.property name*(string or null) or number or boolean or Array of arrays or File (object)additional property

Any of:

string or null

tickets[].ticket_statestringrequired

The state the ticket is currently in

Enum"submitted""in_progress""waiting_on_customer""resolved"

Example: "submitted"

tickets[].ticket_typeobject(Ticket Type)required

A ticket type, used to define the data fields to be captured in a ticket.

tickets[].ticket_type.typestringrequired

String representing the object's type. Always has the value ticket_type.

Value"ticket_type"

Example: "ticket_type"

tickets[].ticket_type.idstringrequired

The id representing the ticket type.

Example: "1295"

tickets[].ticket_type.categorystringrequired

Category of the Ticket Type.

Enum"Customer""Back-office""Tracker"

Example: "Customer"

tickets[].ticket_type.namestringrequired

The name of the ticket type

Example: "Bug"

tickets[].ticket_type.descriptionstringrequired

The description of the ticket type

Example: "A bug that has been reported."

tickets[].ticket_type.iconstringrequired

The icon of the ticket type

Example: "🐞"

tickets[].ticket_type.workspace_idstringrequired

The id of the workspace that the ticket type belongs to.

Example: "ecahpwf5"

tickets[].ticket_type.ticket_type_attributesobject(Ticket Type Attributes)required

A list of attributes associated with a given ticket type.

tickets[].ticket_type.ticket_type_attributes.typestringrequired

String representing the object's type. Always has the value ticket_type_attributes.list.

Value"ticket_type_attributes.list"

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributesArray of objects(Ticket Type Attribute)required

A list of ticket type attributes associated with a given ticket type.

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].typestringrequired

String representing the object's type. Always has the value ticket_type_attribute.

Value"ticket_type_attribute"

Example: "ticket_type_attribute"

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].idstringrequired

The id representing the ticket type attribute.

Example: "1"

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].workspace_idstringrequired

The id of the workspace that the ticket type attribute belongs to.

Example: "ecahpwf5"

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].namestringrequired

The name of the ticket type attribute

Example: "Title"

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].descriptionstringrequired

The description of the ticket type attribute

Example: "Bug title."

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].data_typestringrequired

The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")

Example: "string"

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].input_optionsobjectrequired

Input options for the attribute

Example: "multiline: true"

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].orderintegerrequired

The order of the attribute against other attributes

Example: 1

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].required_to_createbooleanrequired

Whether the attribute is required or not for teammates.

Default false

Example: false

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].required_to_create_for_contactsbooleanrequired

Whether the attribute is required or not for contacts.

Default false

Example: false

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].visible_on_createbooleanrequired

Whether the attribute is visible or not to teammates.

Default true

Example: false

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].visible_to_contactsbooleanrequired

Whether the attribute is visible or not to contacts.

Default true

Example: false

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].defaultbooleanrequired

Whether the attribute is built in or not.

Example: true

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].ticket_type_idintegerrequired

The id of the ticket type that the attribute belongs to.

Example: 42

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].archivedbooleanrequired

Whether the ticket type attribute is archived or not.

Example: false

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].created_atinteger(timestamp)required

The date and time the ticket type attribute was created.

tickets[].ticket_type.ticket_type_attributes.ticket_type_attributes[].updated_atinteger(timestamp)

The date and time the ticket type attribute was last updated.

tickets[].ticket_type.archivedbooleanrequired

Whether the ticket type is archived or not.

Example: false

tickets[].ticket_type.created_atinteger(timestamp)required

The date and time the ticket type was created.

tickets[].ticket_type.updated_atinteger(timestamp)

The date and time the ticket type was last updated.

tickets[].contactsobject(Contacts)required

The list of contacts affected by a ticket.

tickets[].contacts.typestringrequired

always contact.list

Value"contact.list"

Example: "contact.list"

tickets[].contacts.contactsArray of objects(Contact Reference)required

The list of contacts affected by this ticket.

tickets[].contacts.contacts[].typestringrequired

always contact

Value"contact"

Example: "contact"

tickets[].contacts.contacts[].idstringrequired

The unique identifier for the contact which is given by Intercom.

Example: "5ba682d23d7cf92bef87bfd4"

tickets[].contacts.contacts[].external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"

tickets[].admin_assignee_idstring

The id representing the admin assigned to the ticket.

Example: "1295"

tickets[].team_assignee_idstring

The id representing the team assigned to the ticket.

Example: "1295"

tickets[].created_atinteger(date-time)

The time the ticket was created as a UTC Unix timestamp.

Example: 1663597223

tickets[].updated_atinteger(date-time)

The last time the ticket was updated as a UTC Unix timestamp.

Example: 1663597260

tickets[].openboolean

Whether or not the ticket is open. If false, the ticket is closed.

Example: true

tickets[].snoozed_untilinteger(date-time)

The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.

Example: 1663597260

tickets[].linked_objectsobject(Linked Objects)

An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.

tickets[].ticket_partsobject(Ticket Parts)

A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.

tickets[].is_sharedboolean

Whether or not the ticket is shared with the customer.

Example: true

tickets[].ticket_state_internal_labelstring

The state the ticket is currently in, in a human readable form - visible in Intercom

tickets[].ticket_state_external_labelstring

The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.

total_countintegerrequired

A count of the total number of objects.

Example: 12345

pagesobject(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

{
  "type": "ticket.list",
  "tickets": [
    { … }
  ],
  "total_count": 12345,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  }
}

Ticket part author

The author that wrote or triggered the part. Can be a bot, admin, team or user.

typestringrequired

The type of the author

Enum"admin""bot""team""user"

Example: "admin"

idstringrequired

The id of the author

Example: "274"

namestring or null

The name of the author

Example: "Operator"

emailstring(email)required

The email of the author

Example: "operator+abcd1234@intercom.io"

{
  "type": "admin",
  "id": "274",
  "name": "Operator",
  "email": "operator+abcd1234@intercom.io"
}

Ticket Parts

A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.

typestringrequired

Value"ticket_part.list"

Example: "ticket_part.list"

ticket_partsArray of objects(Tickt Parts)required

A list of Ticket Part objects for each ticket. There is a limit of 500 parts.

ticket_parts[].typestringrequired

Always ticket_part

Value"ticket_part"

Example: "ticket_part"

ticket_parts[].idstringrequired

The id representing the ticket part.

Example: "3"

ticket_parts[].part_typestringrequired

The type of ticket part.

Example: "comment"

ticket_parts[].bodystring or nullrequired

The message body, which may contain HTML.

Example: "<p>Okay!</p>"

ticket_parts[].previous_ticket_statestring

The previous state of the ticket.

Enum"submitted""in_progress""waiting_on_customer""resolved"

Example: "submitted"

ticket_parts[].ticket_statestringrequired

The state of the ticket.

Enum"submitted""in_progress""waiting_on_customer""resolved"

Example: "submitted"

ticket_parts[].created_atinteger(date-time)required

The time the ticket part was created.

Example: 1663597223

ticket_parts[].updated_atinteger(date-time)

The last time the ticket part was updated.

Example: 1663597260

ticket_parts[].assigned_toobject(Reference)

reference to another object

ticket_parts[].authorobject(Ticket part author)

The author that wrote or triggered the part. Can be a bot, admin, team or user.

ticket_parts[].attachmentsArray of objects(Ticket part attachments)

A list of attachments for the part.

ticket_parts[].external_idstring or null

The external id of the ticket part

Example: "abcd1234"

ticket_parts[].redactedboolean

Whether or not the ticket part has been redacted.

Example: false

total_countintegerrequired

Example: 2

{
  "type": "ticket_part.list",
  "ticket_parts": [
    { … }
  ],
  "total_count": 2
}

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Ticket List

Ticket part author

Ticket Parts