Merge Ticketing

Tickets

The Ticket object is used to represent a ticket or a task within a system.

Properties

idUUID

Required

remote_idString

Optional

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

nameString

Optional

The ticket's name.

assigneesArray

Required

creatorUUID

Optional

The user who created this ticket.

due_dateDateTime (ISO 8601)

Optional

The ticket's due date.

statusEnum

Optional

The current status of the ticket. Possible values include: OPEN, CLOSED, IN_PROGRESS, ON_HOLD. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

descriptionString

Optional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionsArray

Required

ticket_typeString

Optional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

accountUUID

Optional

The account associated with the ticket.

contactUUID

Optional

The contact associated with the ticket.

parent_ticketUUID

Optional

The ticket's parent ticket.

attachmentsAttachment[]

Required

The Attachment object

The Attachment object is used to represent an attachment for a ticket.

Properties

idUUID

Required

remote_idString

Optional

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

file_nameString

Optional

The attachment's name. It is required to include the file extension in the attachment's name.

ticketUUID

Optional

The ticket associated with the attachment.

file_urlString

Optional

The attachment's url. It is required to include the file extension in the file's URL.

content_typeString

Optional

The attachment's file format.

uploaded_byUUID

Optional

The user who uploaded the attachment.

remote_created_atDateTime (ISO 8601)

Optional

When the third party's attachment was created.

remote_was_deletedBoolean

Required

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.

field_mappingsObject

Optional

remote_dataRemoteData[]

Optional

tagsArray

Required

remote_created_atDateTime (ISO 8601)

Optional

When the third party's ticket was created.

remote_updated_atDateTime (ISO 8601)

Optional

When the third party's ticket was updated.

completed_atDateTime (ISO 8601)

Optional

When the ticket was completed.

remote_was_deletedBoolean

Required

ticket_urlString

Optional

The 3rd party url of the Ticket.

priorityEnum

Optional

The priority or urgency of the Ticket. Possible values include: URGENT, HIGH, NORMAL, LOW. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

field_mappingsObject

Optional

remote_dataRemoteData[]

Optional

remote_fieldsRemoteField[]

Required

GET

/tickets

https://api.merge.dev/api/ticketing/v1/tickets

APAC

Returns a list of Ticket objects.

Query & Path Parameters

account_idString

Optional

If provided, will only return tickets for this account.

assignee_idsString

Optional

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

collection_idsString

Optional

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

completed_afterDateTime (ISO 8601)

Optional

If provided, will only return tickets completed after this datetime.

completed_beforeDateTime (ISO 8601)

Optional

If provided, will only return tickets completed before this datetime.

contact_idString

Optional

If provided, will only return tickets for this contact.

created_afterDateTime (ISO 8601)

Optional

If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)

Optional

If provided, will only return objects created before this datetime.

cursorString

Optional

The pagination cursor value.

due_afterDateTime (ISO 8601)

Optional

If provided, will only return tickets due after this datetime.

due_beforeDateTime (ISO 8601)

Optional

If provided, will only return tickets due before this datetime.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean

Optional

include_remote_dataBoolean

Optional

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

include_remote_fieldsBoolean

Optional

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

include_shell_dataBoolean

Optional

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

modified_afterDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger

Optional

Number of results to return per page.

parent_ticket_idString

Optional

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

priorityString

Optional

If provided, will only return tickets of this priority.

remote_created_afterDateTime (ISO 8601)

Optional

If provided, will only return tickets created in the third party platform after this datetime.

remote_created_beforeDateTime (ISO 8601)

Optional

If provided, will only return tickets created in the third party platform before this datetime.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

remote_idString

Optional

The API provider's ID for the given object.

remote_updated_afterDateTime (ISO 8601)

Optional

If provided, will only return tickets updated in the third party platform after this datetime.

remote_updated_beforeDateTime (ISO 8601)

Optional

If provided, will only return tickets updated in the third party platform before this datetime.

show_enum_originsString

Optional

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

statusString

Optional

If provided, will only return tickets of this status.

tagsString

Optional

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

ticket_typeString

Optional

If provided, will only return tickets of this type.

Field support by integration

See all supported fields

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

Aha!

Asana

Azure DevOps

Basecamp

Bitbucket

ClickUp

Dixa

Freshdesk

Freshservice

Front

GitHub Issues

GitLab

Gladly

Gorgias

Height

Help Scout

Hive

Hubspot Ticketing

Intercom

Ironclad

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Rally

Re:amaze

Salesforce Service Cloud

ServiceNow

Shortcut

SpotDraft

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

POST

/tickets

https://api.merge.dev/api/ticketing/v1/tickets

APAC

Creates a Ticket object with the given values.

Query & Path Parameters

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.

nameString

The ticket's name.

assigneesArray

creatorUUID

The user who created this ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.

due_dateDateTime (ISO 8601)

The ticket's due date.

statusEnum

The current status of the ticket. Must pass in one of the following choices: OPEN, CLOSED, IN_PROGRESS, ON_HOLD.

descriptionString

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionsArray

ticket_typeString

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

accountUUID

The account associated with the ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.

contactUUID

The contact associated with the ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.

parent_ticketUUID

The ticket's parent ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the Ticket object.

attachmentsArray

tagsArray

completed_atDateTime (ISO 8601)

When the ticket was completed.

ticket_urlString

The 3rd party url of the Ticket.

priorityEnum

The priority or urgency of the Ticket. Must pass in one of the following choices: URGENT, HIGH, NORMAL, LOW.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

Field support by integration

See all supported fields

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

Aha!

Asana

Azure DevOps

Basecamp

Bitbucket

ClickUp

Freshdesk

Freshservice

Front

GitHub Issues

GitLab

Gladly

Height

Help Scout

Hive

Intercom

Ironclad

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Rally

Salesforce Service Cloud

ServiceNow

Shortcut

SpotDraft

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

To include the correct model fields when making POST requests, use the GET /tickets/meta/post endpoint. Learn more in our /meta guide.

GET

/tickets/{id}

https://api.merge.dev/api/ticketing/v1/tickets/{id}

APAC

Returns a Ticket object with the given id.

Query & Path Parameters

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID

Required

include_remote_dataBoolean

Optional

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

include_remote_fieldsBoolean

Optional

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

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

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

Field support by integration

See all supported fields

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

Aha!

Asana

Azure DevOps

Basecamp

Bitbucket

ClickUp

Dixa

Freshdesk

Freshservice

Front

GitHub Issues

GitLab

Gladly

Gorgias

Height

Help Scout

Hive

Hubspot Ticketing

Intercom

Ironclad

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Rally

Re:amaze

Salesforce Service Cloud

ServiceNow

Shortcut

SpotDraft

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

PATCH

/tickets/{id}

https://api.merge.dev/api/ticketing/v1/tickets/{id}

APAC

Updates a Ticket object with the given id.

Query & Path Parameters

idUUID

Required

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.

nameString

The ticket's name.

assigneesArray

creatorUUID

The user who created this ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the Creator object.

due_dateDateTime (ISO 8601)

The ticket's due date.

statusEnum

The current status of the ticket. Must pass in one of the following choices: OPEN, CLOSED, IN_PROGRESS, ON_HOLD.

descriptionString

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionsArray

ticket_typeString

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

accountUUID

The account associated with the ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.

contactUUID

The contact associated with the ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.

parent_ticketUUID

The ticket's parent ticket. Must pass in a valid Merge ID, which can be obtained from the id field in the Parent_ticket object.

tagsArray

completed_atDateTime (ISO 8601)

When the ticket was completed.

ticket_urlString

The 3rd party url of the Ticket.

priorityEnum

The priority or urgency of the Ticket. Must pass in one of the following choices: URGENT, HIGH, NORMAL, LOW.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

Field support by integration

See all supported fields

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

Asana

Azure DevOps

ClickUp

Freshdesk

Intercom

Jira

Jira Service Management

Linear

Rally

Salesforce Service Cloud

ServiceNow

Trello

Zendesk

GET

/tickets/{parent_id}/collaborators

https://api.merge.dev/api/ticketing/v1/tickets/{parent_id}/collaborators

APAC

Returns a list of User objects.

Query & Path Parameters

cursorString

Optional

The pagination cursor value.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean

Optional

include_remote_dataBoolean

Optional

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

include_shell_dataBoolean

Optional

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

page_sizeInteger

Optional

Number of results to return per page.

parent_idUUID

Required

Field support by integration

See all supported fields

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

Aha!

Asana

Azure DevOps

Basecamp

Bitbucket

ClickUp

Dixa

Freshdesk

Freshservice

Front

GitHub Issues

GitLab

Gladly

Gorgias

Height

Help Scout

Hive

Hubspot Ticketing

Intercom

Ironclad

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Rally

Re:amaze

Salesforce Service Cloud

ServiceNow

Shortcut

SpotDraft

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

GET

/tickets/meta/patch/{id}

https://api.merge.dev/api/ticketing/v1/tickets/meta/patch/{id}

APAC

Returns metadata for Ticket PATCHs.

Query & Path Parameters

idUUID

Required

Field support by integration

See all supported fields

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

Asana

Azure DevOps

ClickUp

Freshdesk

Intercom

Jira

Jira Service Management

Linear

Rally

Salesforce Service Cloud

ServiceNow

Trello

Zendesk

GET

/tickets/meta/post

https://api.merge.dev/api/ticketing/v1/tickets/meta/post

APAC

Returns metadata for Ticket POSTs.

Field support by integration

See all supported fields

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

Aha!

Asana

Azure DevOps

Basecamp

Bitbucket

ClickUp

Freshdesk

Freshservice

Front

GitHub Issues

GitLab

Gladly

Height

Help Scout

Hive

Intercom

Ironclad

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Rally

Salesforce Service Cloud

ServiceNow

Shortcut

SpotDraft

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

GET

/tickets/remote-field-classes

Beta

https://api.merge.dev/api/ticketing/v1/tickets/remote-field-classes

APAC

Returns a list of RemoteFieldClass objects.

Query & Path Parameters

cursorString

Optional

The pagination cursor value.

include_deleted_dataBoolean

Optional

include_remote_dataBoolean

Optional

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

include_shell_dataBoolean

Optional

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

is_common_model_fieldBoolean

Optional

If provided, will only return remote field classes with this is_common_model_field value

page_sizeInteger

Optional

Number of results to return per page.

Teams

Next Up

Get Started

API Reference

Previous

Next Up