Skip to content

Tickets Object

Relationships

Schema relationships 
graph LR
    Tickets -->|"assignees"| Users
    Tickets -->|"status"| TicketStatus
    Tickets -->|"created_by (type)"| Contacts
    Tickets -->|"created_by (type)"| Users
    Tickets -->|"workspace"| Workspaces
    Tickets -->|"team"| Teams
    Tickets -->|"collections"| Collections
    Tickets -->|"ticket_type"| TicketTypes
    Tickets -->|"contact"| Contacts
    Tickets -->|"additional_contacts"| Contacts
    Tickets -->|"account"| Accounts
    Tickets -->|"parent_ticket"| Tickets
    Tickets -->|"attachments"| Attachments
    Tickets -->|"tags"| Tags
    Tickets -->|"priority"| TicketPriorities

Properties

idstring
required·

The unique identifier for a ticket

accountobject

Account associated with the ticket

References: Accounts → id
idstring

The unique identifier for a contact

additional_contactsobject[]

Additional Contacts associated with the ticket

References: Contacts → id
emailsobject[]

The emails of the contact

2 properties
emailstring
required·

The email of the contact

typestring

The type of the email

first_namestring

The first name of the contact

idstring

The unique identifier for a contact

last_namestring

The last name of the contact

namestring

The name of the contact

phonesobject[]

The contact's phone number

2 properties
numberstring
required·

The contact's phone number

typestring

The type of phone number

assigneesobject[]

Users assigned to the ticket

References: Users → id
emailsobject[]

The user's email addresses

2 properties
emailstring
required·

The user's email address

typestring

The type of email address

first_namestring

The first name of the user

idstring

The unique identifier for a user

last_namestring

The last name of the user

namestring

The name of the user

phonesobject[]

The user's phone number

2 properties
numberstring
required·

The user's phone number

typestring

The type of phone number

attachmentsobject[]

Attachments associated with the ticket

References: Attachments → id
file_namestring

The name of the attachment

file_urlstring

The url of the attachment

idstring

The unique identifier for an attachment

collectionsobject[]

Collections associated with the ticket

References: Collections → id
idstring

The unique identifier for a collection

namestring

The name of the collection

typestring

The type of the collection

completed_atstring · date-time

Time at which the ticket was completed

contactobject

Contact associated with the ticket

References: Contacts → id
emailsobject[]

The emails of the contact

2 properties
emailstring
required·

The email of the contact

typestring

The type of the email

first_namestring

The first name of the contact

idstring

The unique identifier for a contact

last_namestring

The last name of the contact

namestring

The name of the contact

phonesobject[]

The contact's phone number

2 properties
numberstring
required·

The contact's phone number

typestring

The type of phone number

conversationsobject[]

Conversations associated with the ticket

idstring

The unique identifier for a conversation

namestring

The name of the conversation

typestring

The type of the conversation

created_atstring · date-time

Time at which the ticket was created

created_byobject

User or contact who created the ticket

References: Contacts → id (type=contact)
References: Users → id (type=user)
idstring

The unique identifier for a user

namestring

The name of the user

typestring

The type of the user

Possible values:
usercontact
custom_fieldsRecord<string, any>

All the custom fields present on the ticket

descriptionstring

Description of the ticket

due_datestring · date-time

Due date of the ticket

etagstring

The unique identifier for the specific version of the resource.

is_unreadboolean

Whether the ticket is unread

languagesstring[]

Languages of the ticket

namestring

The name of the ticket

numberstring

An optional ticket number maintained by the system.

parent_ticketobject

Parent ticket associated with the ticket

References: Tickets → id
idstring

The unique identifier for a ticket

namestring

The name of the ticket

priorityobject

Priority of the ticket

References: TicketPriorities → id
idstring

The unique identifier for a priority

namestring

The name of the priority

remote_dataRecord<string, any>

Raw data returned from the remote API call.

sourceobject

The source of the ticket

idstring

The unique identifier for a source

namestring

The name of the source

statusobject

The status of the ticket

References: TicketStatus → id
idstring

The unique identifier for a status

namestring

The name of the status

Possible values:
activeclosedopenpendingspamresolvedarchiveddeletedcompleted
tagsobject[]

Tags associated with the ticket

References: Tags → id
idstring

The unique identifier for a tag

namestring

The name of the tag

teamobject

Team associated with the ticket

References: Teams → id
idstring

The unique identifier for a team

namestring

The name of the team

ticket_typeobject

Type of the ticket

References: TicketTypes → id
idstring

The unique identifier for a ticket type

namestring

The name of the ticket type

ticket_urlstring

URL of the ticket

updated_atstring · date-time

Time at which the ticket was last updated

workspaceobject

Workspace associated with the ticket

References: Workspaces → id
idstring

The unique identifier for a workspace

namestring

The name of the workspace