Tasks

The Task object is used to represent a task in the remote system.

The Task object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
subjectString
Optional
The task's subject.
contentString
Optional
The task's content.
ownerString
Optional
accountString
Optional
completed_dateString
Optional
When the task is completed.
due_dateString
Optional
When the task is due.
statusEnum
Optional
The task's status. Possible values include: OPEN, CLOSED, or - in cases where there is no clear mapping - the original value passed through.
remote_dataRemoteData[]
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
The Task object
JSON
{
  "id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
  "remote_id": "19202938",
  "subject": "Contact about Integration Strategy",
  "content": "Follow up to see whether they need integrations",
  "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "completed_date": "2022-02-11T00:00:00Z",
  "due_date": "2022-02-10T00:00:00Z",
  "status": "OPEN",
  "remote_data": [
    {
      "path": "/tasks",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}
GET

/tasks

Returns a list of Task 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.
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, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
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": "03455bc6-6040-430a-848e-aafacbfdf4fg",
      "remote_id": "19202938",
      "subject": "Contact about Integration Strategy",
      "content": "Follow up to see whether they need integrations",
      "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
      "account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "completed_date": "2022-02-11T00:00:00Z",
      "due_date": "2022-02-10T00:00:00Z",
      "status": "OPEN",
      "remote_data": [
        {
          "path": "/tasks",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true
    }
  ]
}
Field support by platform

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
due_dateString
ownerString
remote_idString
statusEnum

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString
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

/tasks/{id}

Returns a Task 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.
Response
JSON
{
  "id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
  "remote_id": "19202938",
  "subject": "Contact about Integration Strategy",
  "content": "Follow up to see whether they need integrations",
  "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "completed_date": "2022-02-11T00:00:00Z",
  "due_date": "2022-02-10T00:00:00Z",
  "status": "OPEN",
  "remote_data": [
    {
      "path": "/tasks",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}
Field support by platform

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
completed_dateString
contentString
due_dateString
ownerString
remote_idString
statusEnum

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

completed_dateString
contentString
due_dateString
ownerString
remote_dataRemoteData[]
remote_idString
statusEnum
subjectString
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

Stages

Next Up

Users