Projects
The Project object is used to represent all projects within a company.
Merge will no longer support the Project common model after April 30th, 2023. This means we will not add any improvements or support any bug fixes related to Projects. We strongly recommend using Collections as it has the same capabilities as Projects and is more comprehensive. If you have any questions, please contact us.

The Project object
Properties

idString
Required

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

nameString
Optional
The project's name.

descriptionString
Optional
The project's description.

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 Project object
JSON
{
"id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
"remote_id": "19202938",
"name": "Q1 Platform",
"description": "For tracking all tasks related to Platform for Q1",
"remote_was_deleted": true,
Show advanced fields
}

GET
/projects

Returns a list of Project objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

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.

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.

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

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",
"remote_was_deleted": true,
Show advanced fields
}
]
}
Field support by platform
Asana
Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Azure DevOps
Azure DevOps

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Basecamp
Basecamp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Bitbucket
Bitbucket

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ClickUp
ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
GitHub Issues
GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
GitLab
GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Height
Height

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hive
Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Jira
Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


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


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Linear
Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Pivotal Tracker
Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Shortcut
Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Teamwork
Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Trello
Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Wrike
Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zoho BugTracker
Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Ironclad
Ironclad
Coming Soon
Salesforce Service Cloud
Salesforce Service Cloud
Coming Soon
Targetprocess
Targetprocess
Coming Soon
Workfront
Workfront
Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/projects/{id}

Returns a Project 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

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
"remote_id": "19202938",
"name": "Q1 Platform",
"description": "For tracking all tasks related to Platform for Q1",
"remote_was_deleted": true,
Show advanced fields
}
Field support by platform
Asana
Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Azure DevOps
Azure DevOps

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Basecamp
Basecamp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Bitbucket
Bitbucket

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ClickUp
ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
GitHub Issues
GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
GitLab
GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Height
Height

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hive
Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Jira
Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


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


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Linear
Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Pivotal Tracker
Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Shortcut
Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Teamwork
Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Trello
Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Wrike
Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zoho BugTracker
Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Ironclad
Ironclad
Coming Soon
Salesforce Service Cloud
Salesforce Service Cloud
Coming Soon
Targetprocess
Targetprocess
Coming Soon
Workfront
Workfront
Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/projects/{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
Asana
Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Azure DevOps
Azure DevOps

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Basecamp
Basecamp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Bitbucket
Bitbucket

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ClickUp
ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Front
Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
GitHub Issues
GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
GitLab
GitLab

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Gladly
Gladly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Height
Height

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hive
Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Jira
Jira

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


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


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Linear
Linear

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Pivotal Tracker
Pivotal Tracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Shortcut
Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Teamwork
Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Trello
Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Wrike
Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zoho BugTracker
Zoho BugTracker

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Ironclad
Ironclad
Coming Soon
Salesforce Service Cloud
Salesforce Service Cloud
Coming Soon
Targetprocess
Targetprocess
Coming Soon
Workfront
Workfront
Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.