Collections
The
Collection object is used to represent one or more Tickets. There can be a hierarchy of Collections, in which a sub-collection belongs to a parent-collection.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringThe collection's name.
descriptionStringThe collection's description.
collection_typeEnumThe collection's type. Possible values include:
LIST, PROJECT. 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.parent_collectionUUIDThe parent collection for this collection.
remote_was_deletedBooleanIndicates 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.
access_levelEnumThe level of access a User has to the Collection and its sub-objects. Possible values include:
PRIVATE, COMPANY, PUBLIC. 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/collections
https://api.merge.dev/api/ticketing/v1/collections
US
EU
APAC
Returns a list of Collection objects.
Query & path parameters
collection_typeStringOptional
If provided, will only return collections of the given type.
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.
cursorStringOptional
The pagination cursor value.
expandStringOptional
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.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
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_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_sizeIntegerOptional
Number of results to return per page.
parent_collection_idStringOptional
If provided, will only return collections whose parent collection matches the given id.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
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
Use the /linked-accounts endpoint to pull platform support information
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Asana
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Azure DevOps
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Basecamp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Bitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
ClickUp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Front
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
GitHub Issues
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
GitLab
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Gladly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Height
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Help Scout
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Hive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Jira
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Jira Data Center
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Jira Service Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Linear
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Pivotal Tracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Rally
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Salesforce Service Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Shortcut
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Teamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Trello
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Wrike
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Zoho BugTracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGET
/collections/{collection_id}/viewers
https://api.merge.dev/api/ticketing/v1/collections/{collection_id}/viewers
US
EU
APAC
Returns a list of Viewer objects that point to a User id or Team id that is either an assignee or viewer on a Collection with the given id. Learn more.
Query & path parameters
collection_idUUIDRequired
cursorStringOptional
The pagination cursor value.
expandStringOptional
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.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
page_sizeIntegerOptional
Number of results to return per page.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringAsana
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringAzure DevOps
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringBasecamp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringBitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringClickUp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringFront
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGitHub Issues
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGitLab
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringGladly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHeight
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHelp Scout
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJira
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJira Data Center
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJira Service Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringLinear
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPivotal Tracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringRally
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringSalesforce Service Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringShortcut
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringTeamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringTrello
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringWrike
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringZoho BugTracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGET
/collections/{id}
https://api.merge.dev/api/ticketing/v1/collections/{id}
US
EU
APAC
Returns a Collection object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
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
Use the /linked-accounts endpoint to pull platform support information
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringAsana
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringAzure DevOps
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringBasecamp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringBitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringClickUp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringFront
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGitHub Issues
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGitLab
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringGladly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHeight
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHelp Scout
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJira
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJira Data Center
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJira Service Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringLinear
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPivotal Tracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringRally
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringSalesforce Service Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringShortcut
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringTeamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringTrello
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
access_levelEnumcollection_typeEnumdescriptionStringnameStringparent_collectionUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringWrike
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringZoho BugTracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
collection_typeEnumdescriptionStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString