Please enable JavaScript to view this site.

Made in EU
HubSpot Forums

Navigation: Catalog: Tickets > Schemas

Tickets: HubSpot Tickets

ListRead a page of tickets. Control what is returned via the `properties` query param.

Catalog: Tickets

Schema: Basic

Label: Tickets

Retrieve: true

Insert: true

Update: false

Delete: false

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Tickets. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

after

 

 

The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

archived

 

 

Whether to return only results that have been archived.

 

Columns of Table Function

The columns of the table function Tickets are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name

Data Type

Label

Required

Documentation

archived

char

Archived

Whether the object is archived.

archivedAt

datetime

Archived at

The timestamp when the object was archived, in ISO 8601 format.

associations

varchar2

Associations

A list defining relationships with other objects.

createdAt

datetime

Created at

The timestamp when the object was created, in ISO 8601 format.

id

varchar2

ID

The unique ID of the object.

objectWriteTraceId

varchar2

 

An identifier used for tracing the creation or update request of the object.

prop_closed_date

datetime

Closed Date

 

prop_content

varchar2

Content

 

prop_created_by

decimal

Created by

 

prop_createdate

datetime

Created at

 

prop_first_agent_reply_date

datetime

First Agent Reply Date

 

prop_hs_all_accessible_team_ids

varchar2

All Accessible Team IDs

 

prop_hs_all_associated_contact_companies

varchar2

 

 

prop_hs_all_associated_contact_emails

varchar2

 

 

prop_hs_all_associated_contact_firstnames

varchar2

 

 

prop_hs_all_associated_contact_lastnames

varchar2

 

 

prop_hs_all_associated_contact_mobilephones

varchar2

 

 

prop_hs_all_associated_contact_phones

varchar2

 

 

prop_hs_all_conversation_mentions

varchar2

All Conversation Mentions

 

prop_hs_all_owner_ids

varchar2

All Owner IDs

 

prop_hs_all_team_ids

varchar2

All Team IDs

 

prop_hs_applied_sla_rule_config_at

datetime

 

 

prop_hs_applied_sla_rule_config_id

decimal

 

 

prop_hs_applied_sla_schedule_at

datetime

 

 

prop_hs_applied_sla_schedule_id

decimal

 

 

prop_hs_assigned_team_ids

varchar2

 

 

prop_hs_assignment_method

varchar2

Assignment Method

 

prop_hs_auto_generated_from_thread_id

decimal

Auto-generated from Thread ID

 

prop_hs_conversations_originating_message_id

varchar2

Conversations Originating Message ID

 

prop_hs_conversations_originating_thread_id

decimal

Conversations Originating Thread ID

 

prop_hs_created_by_user_id

decimal

Created by User ID

 

prop_hs_createdate

datetime

Created at

 

prop_hs_current_generic_channel_id

varchar2

 

 

prop_hs_custom_inbox

decimal

Custom Inbox

 

prop_hs_customer_agent_escalated_time

datetime

 

 

prop_hs_customer_agent_ticket_status

varchar2

 

 

prop_hs_draft_user_ids

varchar2

 

 

prop_hs_email_subject

varchar2

Email Subject

 

prop_hs_external_object_ids

varchar2

External Object IDs

 

prop_hs_file_upload

varchar2

File Upload

 

prop_hs_first_agent_message_sent_at

datetime

First Agent Message Sent at

 

prop_hs_first_assignee_type

varchar2

 

 

prop_hs_form_id

varchar2

 

 

prop_hs_form_submission_conversion_id

varchar2

 

 

prop_hs_has_live_chat_ended_or_email_sent

varchar2

 

 

prop_hs_helpdesk_sort_timestamp

datetime

Helpdesk Sort Timestamp

 

prop_hs_in_helpdesk

char

In Helpdesk

 

prop_hs_inbox_id

decimal

Inbox ID

 

prop_hs_is_closed

char

Is Closed

 

prop_hs_is_latest_message_failed

char

 

 

prop_hs_is_latest_message_hidden_from_all

char

 

 

prop_hs_is_visible_in_help_desk

char

 

 

prop_hs_last_closed_date

datetime

 

 

prop_hs_last_csat_comment

varchar2

 

 

prop_hs_last_csat_date

datetime

 

 

prop_hs_last_csat_rating

varchar2

 

 

prop_hs_last_email_activity

varchar2

Last Email Activity

 

prop_hs_last_email_date

datetime

Last Email Date

 

prop_hs_last_email_details

varchar2

 

 

prop_hs_last_email_type

varchar2

 

 

prop_hs_last_message_from_visitor

char

Last Message from Visitor

 

prop_hs_last_message_received_at

datetime

Last Message Received at

 

prop_hs_last_message_sent_at

datetime

Last Message Sent at

 

prop_hs_last_nps_survey_comment

varchar2

 

 

prop_hs_lastactivitydate

datetime

Last Activity Date

 

prop_hs_lastcontacted

datetime

Last Contacted

 

prop_hs_lastmodifieddate

datetime

Last Modified Date

 

prop_hs_latest_message_attachment_types

varchar2

 

 

prop_hs_latest_message_is_forwarded_email

char

 

 

prop_hs_latest_message_is_thread_comment

char

 

 

prop_hs_latest_message_seen_by_agent_ids

varchar2

Latest Message Seen by Agent IDs

 

prop_hs_latest_message_visible_to_visitor_sent_at

datetime

 

 

prop_hs_latest_message_visible_to_visitor

varchar2

 

 

prop_hs_mentioned_note_user_ids

varchar2

 

 

prop_hs_mentions_resolved_user_ids

varchar2

 

 

prop_hs_mentions_user_ids

varchar2

 

 

prop_hs_merged_object_ids

varchar2

Merged Object IDs

 

prop_hs_most_relevant_sla_status

varchar2

 

 

prop_hs_most_relevant_sla_type

varchar2

 

 

prop_hs_msteams_message_id

varchar2

Microsoft Teams Message ID

 

prop_hs_nextactivitydate

datetime

Next Activity Date

 

prop_hs_notes_last_activity

varchar2

 

 

prop_hs_notes_next_activity_type

varchar2

 

 

prop_hs_notes_next_activity

varchar2

 

 

prop_hs_num_associated_companies

decimal

Number of Associated Companies

 

prop_hs_num_associated_conversations

decimal

 

 

prop_hs_num_times_contacted

decimal

Number of Times Contacted

 

prop_hs_object_id

decimal

Object ID

 

prop_hs_object_source_detail_1

varchar2

 

 

prop_hs_object_source_detail_2

varchar2

 

 

prop_hs_object_source_detail_3

varchar2

 

 

prop_hs_object_source_id

varchar2

 

 

prop_hs_object_source_label

varchar2

 

 

prop_hs_object_source_user_id

decimal

 

 

prop_hs_object_source

varchar2

 

 

prop_hs_originating_channel_instance_id

varchar2

Originating Channel Instance ID

 

prop_hs_originating_email_engagement_id

decimal

Originating Email Engagement ID

 

prop_hs_originating_generic_channel_id

varchar2

Originating Generic Channel ID

 

prop_hs_outbound_ticket

char

 

 

prop_hs_owning_teams

varchar2

 

 

prop_hs_pinned_engagement_id

decimal

Pinned Engagement ID

 

prop_hs_pipeline_stage

varchar2

Pipeline Stage

 

prop_hs_pipeline

varchar2

Pipeline

 

prop_hs_primary_company_id

decimal

 

 

prop_hs_primary_company_name

varchar2

 

 

prop_hs_primary_company

varchar2

 

 

prop_hs_read_only

char

Read-only

 

prop_hs_resolution

varchar2

Resolution

 

prop_hs_retroactive_sla_update_at

datetime

 

 

prop_hs_sales_email_last_replied

datetime

Sales Email Last Replied

 

prop_hs_seen_by_agent_ids

varchar2

 

 

prop_hs_sla_operating_hours

varchar2

 

 

prop_hs_sla_pause_status

varchar2

 

 

prop_hs_snoozed_for_portal

char

 

 

prop_hs_source_object_id

decimal

 

 

prop_hs_source_url

varchar2

 

 

prop_hs_thread_ids_to_restore

varchar2

Thread IDs to Restore

 

prop_hs_ticket_category

varchar2

Ticket Category

 

prop_hs_ticket_id

decimal

Ticket ID

 

prop_hs_ticket_priority

varchar2

Ticket Priority

 

prop_hs_ticket_reopened_at

datetime

 

 

prop_hs_time_to_close_in_operating_hours

decimal

 

 

prop_hs_time_to_first_assign

decimal

 

 

prop_hs_time_to_first_rep_assignment

decimal

 

 

prop_hs_time_to_first_response_in_operating_hours

decimal

 

 

prop_hs_unique_creation_key

varchar2

Unique Creation Key

 

prop_hs_updated_by_user_id

decimal

Updated by User ID

 

prop_hs_user_ids_of_all_notification_followers

varchar2

User IDs of All Notification Followers

 

prop_hs_user_ids_of_all_notification_unfollowers

varchar2

User IDs of All Notification Unfollowers

 

prop_hs_user_ids_of_all_owners

varchar2

User IDs of All Owners

 

prop_hs_waitlist_routing_targets

varchar2

 

 

prop_hs_waitlist_sort_value

datetime

 

 

prop_hs_was_imported

char

Was Imported

 

prop_hubspot_owner_assigneddate

datetime

Owner Assigned Date

 

prop_hubspot_owner_id

varchar2

Owner ID

 

prop_hubspot_team_id

varchar2

Team ID

 

prop_last_engagement_date

datetime

Last Engagement Date

 

prop_last_reply_date

datetime

Last Reply Date

 

prop_notes_last_contacted

datetime

Notes Last Contacted

 

prop_notes_last_updated

datetime

Notes Last Updated

 

prop_notes_next_activity_date

datetime

Notes Next Activity Date

 

prop_nps_follow_up_answer

varchar2

NPS Follow-up Answer

 

prop_nps_follow_up_question_version

decimal

NPS Follow-up Question Version

 

prop_nps_score

varchar2

NPS Score

 

prop_num_contacted_notes

decimal

Number of Contacted Notes

 

prop_num_notes

decimal

Number of Notes

 

prop_source_ref

varchar2

Source Reference

 

prop_source_thread_id

varchar2

Source Thread ID

 

prop_source_type

varchar2

Source Type

 

prop_subject

varchar2

Subject

 

prop_tags

varchar2

Tags

 

prop_time_to_close

decimal

Time to Close

 

prop_time_to_first_agent_reply

decimal

Time to First Agent Reply

 

updatedAt

datetime

Updated at

The timestamp when the object was last updated, in ISO 8601 format.

url

varchar2

URL

The URL on the API that provide direct navigation to the corresponding UI pages for the connectors.

 

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

  
Disclaimer