Common ModelsTickets

/tickets

Returns a list of Ticket objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

account_idstringOptional
If provided, will only return tickets for this account.
assignee_idsstringOptional

If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.

collection_idsstringOptional

If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas.

completed_afterdatetimeOptional
If provided, will only return tickets completed after this datetime.
completed_beforedatetimeOptional
If provided, will only return tickets completed before this datetime.
contact_idstringOptional
If provided, will only return tickets for this contact.
created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
creator_idstringOptional

If provided, will only return tickets created by this creator_id.

creator_idsstringOptional

If provided, will only return tickets created by the creator_ids; multiple creator_ids can be separated by commas.

cursorstringOptional
The pagination cursor value.
due_afterdatetimeOptional
If provided, will only return tickets due after this datetime.
due_beforedatetimeOptional
If provided, will only return tickets due before this datetime.
expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_databooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
namestringOptional
If provided, will only return tickets with this name.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
parent_ticket_idstringOptional

If provided, will only return sub tickets of the parent_ticket_id.

priorityenumOptional
If provided, will only return tickets of this priority. * `URGENT` - URGENT * `HIGH` - HIGH * `NORMAL` - NORMAL * `LOW` - LOW
Allowed values:
remote_created_afterdatetimeOptional
If provided, will only return tickets created in the third party platform after this datetime.
remote_created_beforedatetimeOptional
If provided, will only return tickets created in the third party platform before this datetime.
remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

remote_idstringOptional
The API provider's ID for the given object.
remote_idsstringOptional

If provided, will only return tickets with these remote IDs (comma-separated).

remote_updated_afterdatetimeOptional
If provided, will only return tickets updated in the third party platform after this datetime.
remote_updated_beforedatetimeOptional
If provided, will only return tickets updated in the third party platform before this datetime.
show_enum_originsenumOptional
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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
statusstringOptional
If provided, will only return tickets of this status.
tagsstringOptional

If provided, will only return tickets matching the tags; multiple tags can be separated by commas.

ticket_typestringOptional
If provided, will only return tickets of this type.
ticket_urlstringOptionalformat: "uri"
If provided, will only return tickets where the URL matches or contains the substring

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1cbW/iOBD+K1w+Vrxc2+utinQ6Uej25Uraa9m3W62iIRmCixOntgMtq/3vJycQYJc2QE1IVvupJJgnL88845nxuF8NGyS6jD8ZdUMSe4CS+K5RNjzmIDXqRic6Z5QNCIgJHs4Ps4YHRtkQYRAwLtF5S5A64pxjz6gbNQ+5i5XQJz2CTi35TY34El0OkjBf1JLfVnrRj42yQYk/QKdh2yz0ZSpaPLoC8fDvDkWNEqHuPQAhZJ+z0O3f4kOIIh1Y3RlFD30JtOKAhNocSIXHKMvOqWdwkKJEpwUSWijRVg87uWBfykDUa7U+0qAaXbzq4LCGfg24JDZFUTs6PD54c3xUmaBEV//bculf+3v3D13WfbNnuTa1INxrd+xHs3MxMu/dP8zmH4/m+N2ROR6MzfvB73uWC3vtTvvouvPp8LrV2L9eMsC6+/Pj8fuT1smluWePTw/N+08js2Pvtzv2oDu+OLw8s0eX5/8+muNPB+3Wu0Ozc3p0ecb2r5u3ot28Ze1GtWqUjXlOjfrnr/MnJkbT6MNviyMvPHBx7o3ETEBAKkHYpcSuisMqeDBmPoxE1WZezUOHQK3RB0s8hMCxGkSmGr0nwvzkVRt149Q8b5jN09Yi+Y0hEApdikZd8hB/sF2j/tkAIYjrIyoeQUqw+8oI1JHNKI0vEB95yRccQTIe3YqwOQmimygbToiWAxKNsuGrt6DuhaMvLTkVFUePSbQiAHQsmDunWF88sgKQ/dkp4sw+h4EzAxASZCgiZXYnl1JHEtzoT3TCkk8Bzo5CTo0vCu0hJBydG+DgoUSu3siXb+WlhArwQQ+joKAqMacVylx2UL0P8DlqzUbn4v3p+sR2ptq+Qe4RIQjzq5DQufTbIKAEHUsya5H7lMGcUVxhmETwVhgWCsXD8mHpt4W9HtrymS8jJ2+FYWRKywYEnHjAn+YeP2VgYtnLBs1scdm3oU8eQmXW6EvljZWewLZRCIviEKk6jLXpJK/uZbFCl3ElzJfFy7wg8rOxeDbXcpA8ioKdvpDFs6/RezJDpul/an4b+oGyMSQ4Uja3rkcYhxxLLRxeB0KTq1eIVoxo3UX+wbpiLsuN49dmO5wwTuRT9JHdx4rNxFiymSxOQKANXqDHLKZoK5rEphPGvEGsbALMl2CvaQxaGE9nWBuZRHbDieFqYPOGguwx7nWnsAWJ7hL2NEs3OyKblNiDd5pEOQHLRpOrRgAF89qv89Kvmrxb5FFTND/Vs0LMSsqrOOQJidlJc00G3nIUfQfFQA8NCdyCIreQV02KLSlaTOcnfZpM1LZlDvXGPhERAvmQ2KhXYb055AyUptXpptO+kJyme+A8lVLKxo/J7NpWw3zNAVYEmW4nOsLllY1Ct3N+RsQbyPaMyPOwW7oQIkRN6ewZkf2wa8WQeUxeUiLdH8S3+5jn1d75jMgr6Grjl0I300LFFoLcHeQzmiml4NAnvb4zxtwlnauHScVKQs8Ydwlo8rAJXTHorioJ60Y9u41wNyDtHGlQurNZqDlEUbhCwRY2nE2ZQwvlSM/JUFPGopAKUMAvXgFoc27DrgiYLCUrcZqIjmEzrPusE8Bm6l/XJOTCl8ht5unhYYo2Lzrr/XHr4KrZ3YH4FldiX+1Fi1oKuuDMtyk4mjjmzG9ScCYc55fWhMwsS7Ab0HNJuKYauEJKp+VXJ0tRO1kWrTVlxNSCXxj27G3rapnZamy7btF2hUaZwjVEbLzwplxFSXWKlpqoJm29CZVCz0utV/+qa54NYhMzuIvXckpt8MGNmo91TkeThaIZePU+yGMWtlEPTe4ys235i39CIZmny09M0VZdJH6FXWxlmbgImd0V8RE08UUjrO0t4v0KLXcdWr4+4vteaDlpllov6vspfPUNGTIJtNThYA+0hXYx6ARzd82SK3XXP+OtC7mueAtU97JiBJmvloxdx+U7jsNvsa4I09ypxdGKULOh+sXS3ItxVM6XHe+AougxbmOSKjUpCzXVU2fo1rSpzlbo2/Gtq83S2hcg86Ja7XPtxCBMNtJkDQne9hcuN4vYMsqf81xk2dxa+oxLW1f7whQtgyxa+4bH9S0jj+WUdekPmGxx6GluX1FL346C3WpU/pwb0N9Du/H77SB4I8Y1bWWYomXYMlvQovbrNxCtSzRHSpkmmiOshY6FD+KxNTp7zAnZK7Ob8zD6AycDTQlOBLVtXa5UOf75N/tpmvv+Q1/fLrPpzDcBtY4f2uFH8vZXZfpXZVpjZXqjf+ShIwsqbs16XafA+qx0ErpaK9UKdIZZqEr1z7gvJuK4pc31Kzir9f0G40zqI5suHRdxT/GXb/8Dv45l6qRPAAA=" />