tickets list

GET {{baseUrl}}/tickets

Returns a list of Ticket objects.

Request Params

KeyDatatypeRequiredDescription
summarystringIf provided, will only return tickets for this account.
assignee_idsstringIf provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.
collection_idsstringIf provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas.
completed_afterstringIf provided, will only return tickets completed after this datetime.
completed_beforestringIf provided, will only return tickets completed before this datetime.
summarystringIf provided, will only return tickets for this contact.
created_afterstringIf provided, will only return objects created after this datetime.
created_beforestringIf provided, will only return objects created before this datetime.
cursorstringThe pagination cursor value.
due_afterstringIf provided, will only return tickets due after this datetime.
due_beforestringIf provided, will only return tickets due before this datetime.
expandstringWhich relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_databooleanWhether to include data that was marked as deleted by third party webhooks.
include_remote_databooleanWhether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsbooleanWhether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
modified_afterstringIf provided, only objects synced by Merge after this date time will be returned.
modified_beforestringIf provided, only objects synced by Merge before this date time will be returned.
page_sizenumberNumber of results to return per page.
summarystringIf provided, will only return sub tickets of the parent_ticket_id.
prioritystringIf provided, will only return tickets of this priority.
  • URGENT - URGENT

  • HIGH - HIGH

  • NORMAL - NORMAL

  • LOW - LOW | | remote_created_after | string | | If provided, will only return tickets created in the third party platform after this datetime. | | remote_created_before | string | | If provided, will only return tickets created in the third party platform before this datetime. | | remote_fields | string | | Deprecated. Use show_enum_origins. | | remote_id | string | | The API provider's ID for the given object. | | remote_updated_after | string | | If provided, will only return tickets updated in the third party platform after this datetime. | | remote_updated_before | string | | If provided, will only return tickets updated in the third party platform before this datetime. | | show_enum_origins | string | | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more | | status | string | | If provided, will only return tickets of this status.

  • OPEN - OPEN

  • CLOSED - CLOSED

  • IN_PROGRESS - IN_PROGRESS

  • ON_HOLD - ON_HOLD | | tags | string | | If provided, will only return tickets matching the tags; multiple tags can be separated by commas. | | ticket_type | string | | If provided, will only return tickets of this type. |

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

RESPONSES

status: OK

{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id":"19202938","created_at":"2021-09-15T00:00:00Z","modified_at":"2021-10-16T00:00:00Z","name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"urn:uuid:8db5c185-624c-8b5e-efb2-ab1f516bed17","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","attachments":["42747df1-95e7-46e2-93cc-66f1191edca5","92f972d0-2526-434b-9409-4c3b468e08f0"],"tags":["enterprise","other-tag"],"remote_created_at":"2021-11-10T00:00:00Z","remote_updated_at":"2021-12-09T00:00:00Z","completed_at":"2021-12-09T00:00:00Z","remote_was_deleted":false,"ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH","field_mappings":{"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},"remote_data":[{"path":"sunt exercitation Lorem","data":{"readOnly":true}},{"path":"aliquip tempor ullamco","data":{"readOnly":true}}],"remote_fields":[{"remote_field_class":{"id":"do minim fugia","display_name":"cupidatat mollit sed","remote_key_name":"ullamco ut ut pariatur officia","description":"ut veniam et eu","is_custom":true,"is_required":true,"field_type":"number","field_format":"string","field_choices":["sint enim","Ut labore consec"],"item_schema":{"item_type":"list","item_format":"date","item_choices":["dolore ullam","officia labore ut "]}},"value":{"sed_9":{},"laboris_c1":{},"idd6":{},"laboris_2f":{}}},{"remote_field_class":{"id":"qui aliqua","display_name":"id exercitation culpa","remote_key_name":"proident","description":"aliquip","is_custom":false,"is_required":false,"field_type":"date","field_format":"list","field_choices":["nostrud adipisicing","Excepteur ullamco deserunt"],"item_schema":{"item_type":"string","item_format":"number","item_choices":["cupidatat adipisicing reprehenderit laborum","nis"]}},"value":{"et36":{},"infa1":{}}}]},{"id":"0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id":"19202938","created_at":"2021-09-15T00:00:00Z","modified_at":"2021-10-16T00:00:00Z","name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"urn:uuid:a82c9a62-fd97-a686-b7cf-d892aa56fefb","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","attachments":["42747df1-95e7-46e2-93cc-66f1191edca5","92f972d0-2526-434b-9409-4c3b468e08f0"],"tags":["enterprise","other-tag"],"remote_created_at":"2021-11-10T00:00:00Z","remote_updated_at":"2021-12-09T00:00:00Z","completed_at":"2021-12-09T00:00:00Z","remote_was_deleted":true,"ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH","field_mappings":{"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},"remote_data":[{"path":"ipsum id Duis","data":{"readOnly":true}},{"path":"dolor proident","data":{"readOnly":true}}],"remote_fields":[{"remote_field_class":{"id":"qui culpa pariatur tempor in","display_name":"eu Lorem commodo est ex","remote_key_name":"ullamco deserunt","description":"fugiat cillum amet elit","is_custom":true,"is_required":false,"field_type":"date","field_format":"list","field_choices":["consectetur dolor","minim enim eiusmod ipsum"],"item_schema":{"item_type":"list","item_format":"list","item_choices":["enim reprehenderit do","Ut qui pariatur"]}},"value":{"nisi_6":{},"eaf0f":{}}},{"remote_field_class":{"id":"velit in in incididunt","display_name":"et ad Excepteur est","remote_key_name":"cillum esse","description":"incididunt officia","is_custom":false,"is_required":false,"field_type":"bool","field_format":"number","field_choices":["et","adipisicing consequat nulla ad"],"item_schema":{"item_type":"list","item_format":"bool","item_choices":["commodo veniam et","dolor Duis"]}},"value":{"voluptate_9e":{},"eu5":{},"consequat967":{}}}]}]}