Skip to content

Tickets Object ​



id
string
REQUIRED · The unique identifier for a ticket
name
string
The name of the ticket
number
string
An optional ticket number maintained by the system.
assignees
object[]
Users assigned to the ticket
id
string
The unique identifier for a user
name
string
The name of the user
first_name
string
The first name of the user
last_name
string
The last name of the user
emails
object[]
The user's email addresses
email
string
REQUIRED · The user's email address
type
string
The type of email address
status
object
The status of the ticket
id
string
The unique identifier for a status
name
string
The name of the status
All possible enum values:
  • active
  • closed
  • open
  • pending
  • spam
  • resolved
  • archived
  • deleted
  • completed
created_by
object
User or contact who created the ticket
id
string
The unique identifier for a user
name
string
The name of the user
type
string
The type of the user
All possible enum values:
  • user
  • contact
due_date
string · date-time
Due date of the ticket
description
string
Description of the ticket
workspace
object
Workspace associated with the ticket
id
string
The unique identifier for a workspace
name
string
The name of the workspace
team
object
Team associated with the ticket
id
string
The unique identifier for a team
name
string
The name of the team
collections
object[]
Collections associated with the ticket
id
string
The unique identifier for a collection
name
string
The name of the collection
ticket_type
object
Type of the ticket
id
string
The unique identifier for a ticket type
name
string
The name of the ticket type
contact
object
Contact associated with the ticket
id
string
The unique identifier for a contact
first_name
string
The first name of the contact
last_name
string
The last name of the contact
name
string
The name of the contact
emails
object[]
The emails of the contact
email
string
REQUIRED · The email of the contact
type
string
The type of the email
parent_ticket
object
Parent ticket associated with the ticket
id
string
The unique identifier for a ticket
name
string
The name of the ticket
attachments
object[]
Attachments associated with the ticket
id
string
The unique identifier for an attachment
file_name
string
The name of the attachment
file_url
string
The url of the attachment
tags
object[]
Tags associated with the ticket
id
string
The unique identifier for a tag
name
string
The name of the tag
created_at
string · date-time
Time at which the ticket was created
updated_at
string · date-time
Time at which the ticket was last updated
completed_at
string · date-time
Time at which the ticket was completed
ticket_url
string
URL of the ticket
priority
object
Priority of the ticket
id
string
The unique identifier for a priority
name
string
The name of the priority
languages
string[]
Languages of the ticket
is_unread
boolean
Whether the ticket is unread
source
object
id
string
The unique identifier for a source
name
string
The name of the source
remote_data
object
Raw data returned from the remote API call.