Collections

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

The Collection object
Properties
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
nameString
Optional
The collection's name.
descriptionString
Optional
The collection's description.
collection_typeEnum
Optional
The collection's type. Possible values include: LIST, PROJECT, or - in cases where there is no clear mapping - the original value passed through.
parent_collectionString
Optional
The parent collection for this collection.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
modified_atString
Required
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]
Optional
The Collection object
JSON
{
  "id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
  "remote_id": "19202938",
  "name": "Q1 Platform",
  "description": "For tracking all tasks related to Platform for Q1",
  "collection_type": "LIST",
  "parent_collection": "25782302-5be1-4d78-8f46-2a5db72204ef",
  "remote_was_deleted": true,
Show advanced fields
}
GET
/collections

Returns a list of Collection objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
collection_typeString
Optional
If provided, will only return collections of the given type.
created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
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_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeString
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
Which fields should be returned in non-normalized form.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
      "remote_id": "19202938",
      "name": "Q1 Platform",
      "description": "For tracking all tasks related to Platform for Q1",
      "collection_type": "LIST",
      "parent_collection": "25782302-5be1-4d78-8f46-2a5db72204ef",
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}
Field support by platform
Aha!
Aha!

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Asana
Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Azure DevOps
Azure DevOps

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Basecamp
Basecamp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Bitbucket
Bitbucket

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
ClickUp
ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
GitHub Issues
GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
GitLab
GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Height
Height

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Help Scout
Help Scout

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Hive
Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jira
Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jira Service Management
Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Linear
Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Pivotal Tracker
Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Shortcut
Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Teamwork
Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Trello
Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Wrike
Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Zoho BugTracker
Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/collections/{id}

Returns a Collection object with the given id.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
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
Which fields should be returned in non-normalized form.
Response
JSON
{
  "id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
  "remote_id": "19202938",
  "name": "Q1 Platform",
  "description": "For tracking all tasks related to Platform for Q1",
  "collection_type": "LIST",
  "parent_collection": "25782302-5be1-4d78-8f46-2a5db72204ef",
  "remote_was_deleted": true,
Show advanced fields
}
Field support by platform
Aha!
Aha!

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Asana
Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Azure DevOps
Azure DevOps

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Basecamp
Basecamp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Bitbucket
Bitbucket

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
ClickUp
ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
GitHub Issues
GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
GitLab
GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Height
Height

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Help Scout
Help Scout

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Hive
Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jira
Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jira Service Management
Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Linear
Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Pivotal Tracker
Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Shortcut
Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Teamwork
Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Trello
Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Wrike
Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Zoho BugTracker
Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/collections/{parent_id}/users

Returns a list of User objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
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_idString
Required
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "17a54124-287f-494d-965e-3c5b330c9a68",
      "remote_id": "19202938",
      "name": "Gil Feig",
      "email_address": "[email protected]",
      "is_active": true,
      "teams": [
        "28b54125-287f-494d-965e-3c5b330c9a68",
        "17a54124-287f-494d-965e-3c5b330c9a68"
      ],
      "avatar": "https://merge.dev/user_profile_pic.png",
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}
Field support by platform
Aha!
Aha!

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Asana
Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Azure DevOps
Azure DevOps

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Basecamp
Basecamp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Bitbucket
Bitbucket

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
ClickUp
ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
GitHub Issues
GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
GitLab
GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Height
Height

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Help Scout
Help Scout

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Hive
Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jira
Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jira Service Management
Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Linear
Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Pivotal Tracker
Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Shortcut
Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Teamwork
Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Trello
Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
parent_collectionString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Wrike
Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Zoho BugTracker
Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

collection_typeEnum
descriptionString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
Previous
Attachments
Next Up
Comments