Merge · Schema

Task

# The Task Object ### Description The `Task` object is used to represent a task, such as a to-do item. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
subject	stringnull	The task's subject.
content	stringnull	The task's content.
owner	stringnull	The task's owner.
account	stringnull	The task's account.
opportunity	stringnull	The task's opportunity.
contact	stringnull	The task's contact.
completed_date	stringnull	When the task is completed.
due_date	stringnull	When the task is due.
status	object	The task's status.
task_url	stringnull	The task's URL in the remote system.
remote_was_deleted	boolean	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 cove
field_mappings	object
remote_data	arraynull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Task",
  "title": "Task",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "subject": {
      "type": [
        "string",
        "null"
      ],
      "description": "The task's subject."
    },
    "content": {
      "type": [
        "string",
        "null"
      ],
      "description": "The task's content."
    },
    "owner": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's owner."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's account."
    },
    "opportunity": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's opportunity."
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The task's contact."
    },
    "completed_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the task is completed."
    },
    "due_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the task is due."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TaskStatusEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The task's status."
    },
    "task_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The task's URL in the remote system."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TaskFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteField"
      }
    }
  },
  "description": "# The Task Object\n### Description\nThe `Task` object is used to represent a task, such as a to-do item.\n### Usage Example\nTODO"
}