Collections

The Collection object is used to represent collections of tickets. Collections may include other collections as sub collections.

Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

nameString
Optional
The collection's name.

descriptionString
Optional
The collection's description.

collection_typeEnum
Optional
The collection's type. Possible values include: LIST, PROJECT. In cases where there is no clear mapping, the original value passed through will be returned.

parent_collectionUUID
Optional
The parent collection for this collection.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

access_levelEnum
Optional
The 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.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/collections

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

US
EU

Returns a list of Collection objects.


Query & Path Parameters

collection_typeString
Optional
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.

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
Whether to include data that was marked as deleted by third party webhooks.

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

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_collection_idString
Optional
If provided, will only return collections whose parent collection matches the given id.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Aha!
Aha!
Asana
Asana
Azure DevOps
Azure DevOps
Basecamp
Basecamp
Bitbucket
Bitbucket
ClickUp
ClickUp
Front
Front
GitHub Issues
GitHub Issues
GitLab
GitLab
Gladly
Gladly
Height
Height
Help Scout
Help Scout
Hive
Hive
Jira
Jira
Jira Service Management
Jira Service Management
Linear
Linear
Pivotal Tracker
Pivotal Tracker
Rally
Rally
Shortcut
Shortcut
Teamwork
Teamwork
Trello
Trello
Wrike
Wrike
Zoho BugTracker
Zoho BugTracker
GET
/collections/{id}

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

US
EU

Returns a Collection 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.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Aha!
Aha!
Asana
Asana
Azure DevOps
Azure DevOps
Basecamp
Basecamp
Bitbucket
Bitbucket
ClickUp
ClickUp
Front
Front
GitHub Issues
GitHub Issues
GitLab
GitLab
Gladly
Gladly
Height
Height
Help Scout
Help Scout
Hive
Hive
Jira
Jira
Jira Service Management
Jira Service Management
Linear
Linear
Pivotal Tracker
Pivotal Tracker
Rally
Rally
Shortcut
Shortcut
Teamwork
Teamwork
Trello
Trello
Wrike
Wrike
Zoho BugTracker
Zoho BugTracker
GET
/collections/{parent_id}/users

https://api.merge.dev/api/ticketing/v1/collections/{parent_id}/users

US
EU

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
Whether to include data that was marked as deleted by third party webhooks.

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

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!
Aha!
Asana
Asana
Azure DevOps
Azure DevOps
Basecamp
Basecamp
Bitbucket
Bitbucket
ClickUp
ClickUp
Front
Front
GitHub Issues
GitHub Issues
GitLab
GitLab
Gladly
Gladly
Height
Height
Help Scout
Help Scout
Hive
Hive
Jira
Jira
Jira Service Management
Jira Service Management
Linear
Linear
Pivotal Tracker
Pivotal Tracker
Rally
Rally
Shortcut
Shortcut
Teamwork
Teamwork
Trello
Trello
Wrike
Wrike
Zoho BugTracker
Zoho BugTracker