Retrieve Tickets
Retrieve Tickets from any connected Ticketing software
Path parameters
id of the ticket you want to retrive.
Query parameters
Set to true to include data from the original Ticketing software.
Headers
The connection token
Response
Example response
{
"name": "Customer Service Inquiry",
"status": "OPEN",
"description": "Help customer",
"due_date": "2024-10-01T12:00:00Z",
"type": "BUG",
"parent_ticket": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"collections": [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
],
"tags": [
"my_tag",
"urgent_tag"
],
"completed_at": "2024-10-01T12:00:00Z",
"priority": "HIGH",
"assigned_to": [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
],
"comment": {
"body": "Assigned to Eric !",
"html_body": "<p>Assigned to Eric !</p>",
"creator_type": "USER",
"ticket_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"attachments": [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
]
},
"account_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"attachments": [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
],
"field_mappings": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"remote_id": "id_1",
"remote_data": {
"key1": "value1",
"key2": 42,
"key3": true
},
"created_at": "2024-10-01T12:00:00Z",
"modified_at": "2024-10-01T12:00:00Z"
}Changes
Changed in 7 of the 18 revisions of this API.791120
- ○
removed the
BUGenum value from thetyperesponse property for the response status200response-property-enum-value-removed
- ○
removed the
CLOSEDenum value from thestatusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
CONTACTenum value from thecomment/allOf[UnifiedTicketingCommentInput]/creator_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
HIGHenum value from thepriorityresponse property for the response status200response-property-enum-value-removed
- ○
removed the
LISTenum value from thecollections/items/oneOf[UnifiedTicketingCollectionOutput]/collection_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
LOWenum value from thepriorityresponse property for the response status200response-property-enum-value-removed
- ○
removed the
MEDIUMenum value from thepriorityresponse property for the response status200response-property-enum-value-removed
- ○
removed the
OPENenum value from thestatusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PROJECTenum value from thecollections/items/oneOf[UnifiedTicketingCollectionOutput]/collection_typeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
SUBTASKenum value from thetyperesponse property for the response status200response-property-enum-value-removed
- ○
removed the
TASKenum value from thetyperesponse property for the response status200response-property-enum-value-removed
- ○
removed the
TO-DOenum value from thetyperesponse property for the response status200response-property-enum-value-removed
- ○
removed the
USERenum value from thecomment/allOf[UnifiedTicketingCommentInput]/creator_typeresponse property for the response status200response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ▲
added
UnifiedTicketingAttachmentInputsubschema #1to theattachments/items/response propertyoneOflist for the response status200response-property-one-of-added
- ▲
added
UnifiedTicketingAttachmentOutputsubschema #1to thecomment/allOf[UnifiedTicketingCommentInput]/attachments/items/response propertyoneOflist for the response status200response-property-one-of-added
- ▲
added
UnifiedTicketingTagOutputsubschema #1to thetags/items/response propertyoneOflist for the response status200response-property-one-of-added
- ▲
the
attachments/items/response's property type/format changed fromstring/to/for status200response-property-type-changed
- ▲
the
collectionsresponse's property type/format changed fromstring/toarray/for status200response-property-type-changed
- ▲
the
comment/allOf[UnifiedTicketingCommentInput]/attachments/items/response's property type/format changed fromstring/to/for status200response-property-type-changed
- ▲
the
tags/items/response's property type/format changed fromstring/to/for status200response-property-type-changed
- ▲
- ●
added the new
BUGenum value to thetyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
CLOSEDenum value to thestatusresponse property for the response status200response-property-enum-value-added
- ●
added the new
CONTACTenum value to thecomment/allOf[UnifiedTicketingCommentInput]/creator_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
HIGHenum value to thepriorityresponse property for the response status200response-property-enum-value-added
- ●
added the new
LOWenum value to thepriorityresponse property for the response status200response-property-enum-value-added
- ●
added the new
MEDIUMenum value to thepriorityresponse property for the response status200response-property-enum-value-added
- ●
added the new
OPENenum value to thestatusresponse property for the response status200response-property-enum-value-added
- ●
added the new
SUBTASKenum value to thetyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
TASKenum value to thetyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
TO-DOenum value to thetyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
USERenum value to thecomment/allOf[UnifiedTicketingCommentInput]/creator_typeresponse property for the response status200response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
the response property
account_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
assigned_tobecame nullable for the status200response-property-became-nullable
- ▲
the response property
attachmentsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
collectionsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
commentbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/attachmentsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/bodybecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/contact_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/creator_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/html_bodybecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/is_privatebecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/ticket_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/user_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
completed_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
contact_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
descriptionbecame nullable for the status200response-property-became-nullable
- ▲
the response property
due_datebecame nullable for the status200response-property-became-nullable
- ▲
the response property
field_mappingsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
modified_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
parent_ticketbecame nullable for the status200response-property-became-nullable
- ▲
the response property
prioritybecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_databecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
statusbecame nullable for the status200response-property-became-nullable
- ▲
the response property
tagsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame optional for the status200response-property-became-optional
- ▲
the response property
field_mappingsbecame optional for the status200response-property-became-optional
- ▲
the response property
modified_atbecame optional for the status200response-property-became-optional
- ▲
the response property
remote_databecame optional for the status200response-property-became-optional
- ▲
the
created_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the
created_atresponse's property type/format changed fromstring/date-timetoobject/for status200response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromstring/date-timetoobject/for status200response-property-type-changed
- ○
the endpoint scheme security
bearerwas added to the APIapi-security-added
- ○
the response property
created_atbecame required for the status200response-property-became-required
- ○
the response property
field_mappingsbecame required for the status200response-property-became-required
- ○
the response property
modified_atbecame required for the status200response-property-became-required
- ○
the response property
remote_databecame required for the status200response-property-became-required
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the response property
account_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
assigned_tobecame nullable for the status200response-property-became-nullable
- ▲
the response property
attachmentsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
collectionsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
commentbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/attachmentsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/bodybecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/contact_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/creator_typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/html_bodybecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/is_privatebecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/ticket_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
comment/allOf[UnifiedTicketingCommentInput]/user_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
completed_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
contact_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
descriptionbecame nullable for the status200response-property-became-nullable
- ▲
the response property
due_datebecame nullable for the status200response-property-became-nullable
- ▲
the response property
field_mappingsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
modified_atbecame nullable for the status200response-property-became-nullable
- ▲
the response property
namebecame nullable for the status200response-property-became-nullable
- ▲
the response property
parent_ticketbecame nullable for the status200response-property-became-nullable
- ▲
the response property
prioritybecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_databecame nullable for the status200response-property-became-nullable
- ▲
the response property
remote_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
statusbecame nullable for the status200response-property-became-nullable
- ▲
the response property
tagsbecame nullable for the status200response-property-became-nullable
- ▲
the response property
typebecame nullable for the status200response-property-became-nullable
- ▲
the response property
created_atbecame optional for the status200response-property-became-optional
- ▲
the response property
field_mappingsbecame optional for the status200response-property-became-optional
- ▲
the response property
modified_atbecame optional for the status200response-property-became-optional
- ▲
the response property
remote_databecame optional for the status200response-property-became-optional
- ▲
the
created_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
- ▲
the
modified_atresponse's property type/format changed fromobject/tostring/date-timefor status200response-property-type-changed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
the endpoint scheme security
bearerwas removed from the APIapi-security-removed
- ○