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 specified collection_ids, including tickets in any nested or child collections. 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

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information