Back to top

API Documentation

Tasks

Overview

A Task is an object, assigned to a user to do some job and has a certain due date. Tasks can have Reminders set on them.

Data model

Task

Default value for status is PENDING

Field Type Required? Notes
created_by User User who created the task
title String ✓
description String
due_date Timestamp ✓ Should be UTC timestamp in ms.
end_date Timestamp Should be UTC timestamp in ms.
assignees User[] Users assigned to the task.
associations Association[] A related listing
status String Enum PENDING, DONE
task_type String Enum ✓ Call, Message, Todo
reminders Reminder[]
type String crm_task

Task’s available model associations are as follows:

  • crm_task.assignees

  • crm_task.associations

  • crm_task.created_by

  • crm_task.updated_by

  • crm_task.files

  • crm_task.reminders

Reminder

Field Type Required? Notes
timestamp timestamp ✓ Fixed timestamp for the reminder
is_relative boolean ✓ Whether the reminder is relative to task’s due date
type string reminder

Association

Depending on the association_type value, one of deal, contact or listing is also required.

Field Type Required? Notes
created_at timestamp
deleted_at timestamp
created_by UUID
brand UUID
crm_task UUID Parent Task Id
listing UUID Associated listing id
contact UUID Associated contact id
deal UUID Associated deal id
index UUID A number used for ordering
metadata UUID A json holding metadata for event
association_type String Enum ✓ deal or contact or listing
type String crm_association

Get tasks

Get tasks
GET/crm/tasks

Example URI

GET /crm/tasks
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "created_at": 1765163654.156179,
      "updated_at": 1765163654.156179,
      "deleted_at": null,
      "title": "Hello, Task World!",
      "description": null,
      "due_date": 1765163654.099,
      "end_date": 1765170854.099,
      "status": "PENDING",
      "task_type": "Todo",
      "all_day": false,
      "metadata": {
        "template": "<html></html>"
      },
      "kind": "Task",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "type": "crm_task"
    }
  ],
  "info": {
    "count": 1,
    "total": 1
  }
}

Get a task by id

Get a task by id
GET/crm/tasks/:id

Example URI

GET /crm/tasks/:id
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
associations
array (optional) Example: crm_task.associations,crm_task.assignees
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
    "created_at": 1765163654.156179,
    "updated_at": 1765163654.156179,
    "deleted_at": null,
    "title": "Hello, Task World!",
    "description": null,
    "due_date": 1765163654.099,
    "end_date": 1765170854.099,
    "status": "DONE",
    "task_type": "Todo",
    "all_day": false,
    "metadata": {
      "template": "<html></html>"
    },
    "kind": "Task",
    "assignees": [
      {
        "type": "user",
        "username": null,
        "first_name": "Unit",
        "last_name": "Test",
        "email": "[email protected]",
        "phone_number": "+4368120265807",
        "created_at": 1493115498.770362,
        "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1765163655.314978,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": true,
        "timezone": "America/Chicago",
        "user_type": "Agent",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": false,
        "personal_room": null,
        "brand": null,
        "fake_email": false,
        "features": [
          "Deals"
        ],
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": true,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "current_time": "9:14 PM - Sunday Dec 07, 2025",
        "push_allowed": true,
        "agents": [
          {
            "id": "f279d248-9c84-48d9-b541-6437459b2b4f",
            "email": "[email protected]",
            "mlsid": "00920130",
            "fax": "(972) 264-4703",
            "full_name": "Gholi Sweet",
            "first_name": "Gholi",
            "last_name": "Sweet",
            "middle_name": null,
            "phone_number": "(972) 264-4703",
            "nar_number": "797500044",
            "office_mui": "15512742",
            "status": "Active",
            "office_mlsid": "RCHT01X",
            "work_phone": "(469) 358-8080",
            "generational_name": null,
            "matrix_unique_id": "155155530",
            "updated_at": 1765163654.254344,
            "deleted_at": null,
            "created_at": 1765163654.254344,
            "mls": "NTREIS",
            "license_number": null,
            "designation": null,
            "nrds": "01053140",
            "type": "agent",
            "office_id": null,
            "secret_questions": [
              "(972) XXX-XX03",
              "jewellxxxxxxxxxxxxxal.net",
              "(469) XXX-XX80"
            ]
          }
        ],
        "last_seen_type": null,
        "active_brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      }
    ],
    "associations": [
      {
        "id": "8b1065c2-b546-4710-a80f-27a7a79ebcd1",
        "created_at": 1765163657.826045,
        "updated_at": 1765163657.826045,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "contact",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "index": 1,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      },
      {
        "id": "351747fd-bd4b-4fdf-ba36-0d8f8a72cb9b",
        "created_at": 1765163657.440047,
        "updated_at": 1765163657.440047,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "listing",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "index": null,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      },
      {
        "id": "29da8529-fe57-40f8-9ae7-ff71a859901f",
        "created_at": 1765163658.055264,
        "updated_at": 1765163658.055264,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "contact",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "index": null,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      },
      {
        "id": "3943d6d9-7849-4bc3-b10c-0a34aecbb0fc",
        "created_at": 1765163658.055347,
        "updated_at": 1765163658.055347,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "contact",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "index": null,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      }
    ],
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "type": "crm_task",
    "contacts": [
      "a33dc03d-a489-40e3-8452-3be8fb777182",
      "f2999691-8542-4e3c-9ecb-36d298e36729",
      "91c94064-4290-4005-9bfa-24abe4f5341a"
    ],
    "deals": [],
    "listings": [
      "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
    ],
    "emails": []
  }
}

Filter tasks

Filter tasks
GET/crm/tasks/search

Example URI

GET /crm/tasks/search
URI Parameters
HideShow
q
string (optional) Example: Hello World

String search in title and description

assignee
string (optional) 
contact
string (optional) Example: a33dc03d-a489-40e3-8452-3be8fb777182
deal
string (optional) 
listing
string (optional) 
due_gte
number (optional) 

Due date greater than or equal to

due_lte
number (optional) 

Due date less than or equal to

status
string (optional) 
  • Members:
    • PENDING
    • DONE
task_type
string (optional) 
  • Members:
    • Call
    • Message
    • Todo
start
number (optional) 
limit
number (optional) Default: 10 Example: 10
order
string (optional) Example: -due_date

Put a minus sign before field name for descending order

  • Members:
    • due_date
    • created_at
    • updated_at
associations
array (optional) Example: crm_task.associations
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "created_at": 1765163654.156179,
      "updated_at": 1765163654.156179,
      "deleted_at": null,
      "title": "Hello, Task World!",
      "description": null,
      "due_date": 1765163654.099,
      "end_date": 1765170854.099,
      "status": "DONE",
      "task_type": "Todo",
      "all_day": false,
      "metadata": {
        "template": "<html></html>"
      },
      "kind": "Task",
      "associations": [
        {
          "id": "8b1065c2-b546-4710-a80f-27a7a79ebcd1",
          "created_at": 1765163657.826045,
          "updated_at": 1765163657.826045,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "association_type": "contact",
          "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
          "index": 1,
          "metadata": {
            "origin": "rechat"
          },
          "type": "crm_association"
        },
        {
          "id": "351747fd-bd4b-4fdf-ba36-0d8f8a72cb9b",
          "created_at": 1765163657.440047,
          "updated_at": 1765163657.440047,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "association_type": "listing",
          "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
          "index": null,
          "metadata": {
            "origin": "rechat"
          },
          "type": "crm_association"
        },
        {
          "id": "29da8529-fe57-40f8-9ae7-ff71a859901f",
          "created_at": 1765163658.055264,
          "updated_at": 1765163658.055264,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "association_type": "contact",
          "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
          "index": null,
          "metadata": {
            "origin": "rechat"
          },
          "type": "crm_association"
        },
        {
          "id": "3943d6d9-7849-4bc3-b10c-0a34aecbb0fc",
          "created_at": 1765163658.055347,
          "updated_at": 1765163658.055347,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "association_type": "contact",
          "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
          "index": null,
          "metadata": {
            "origin": "rechat"
          },
          "type": "crm_association"
        }
      ],
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "type": "crm_task",
      "contacts": [
        "a33dc03d-a489-40e3-8452-3be8fb777182",
        "f2999691-8542-4e3c-9ecb-36d298e36729",
        "91c94064-4290-4005-9bfa-24abe4f5341a"
      ],
      "deals": [],
      "listings": [
        "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
      ],
      "emails": []
    }
  ],
  "info": {
    "count": 1,
    "total": 1
  }
}

Create a new task

Create a new task
POST/crm/tasks

Example URI

POST /crm/tasks
URI Parameters
HideShow
associations
array (optional) Example: crm_task.associations,crm_task.assignees
Request
HideShow
Body
{
  "title": "Hello, Task World!",
  "due_date": 1765163654.099,
  "end_date": 1765170854.099,
  "task_type": "Todo",
  "metadata": {
    "template": "<html></html>"
  },
  "associations": [
    {
      "association_type": "listing",
      "listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
      "metadata": {
        "origin": "rechat"
      }
    }
  ],
  "assignees": [
    "601b91e2-f50c-45d0-bcf4-c1c0a2298a3a"
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
    "created_at": 1765163654.156179,
    "updated_at": 1765163654.156179,
    "deleted_at": null,
    "title": "Hello, Task World!",
    "description": null,
    "due_date": 1765163654.099,
    "end_date": 1765170854.099,
    "status": "PENDING",
    "task_type": "Todo",
    "all_day": false,
    "metadata": {
      "template": "<html></html>"
    },
    "kind": "Task",
    "assignees": [
      {
        "type": "user",
        "username": null,
        "first_name": "Abbas",
        "last_name": "Gholavi",
        "email": "[email protected]",
        "phone_number": "+989123456789",
        "created_at": 1765163657.146574,
        "id": "601b91e2-f50c-45d0-bcf4-c1c0a2298a3a",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1765163657.146596,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": false,
        "timezone": "America/Chicago",
        "user_type": "Client",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": null,
        "personal_room": "c2ddf550-e3eb-40f8-81ba-5ed4683e7cad",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "fake_email": null,
        "features": null,
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": false,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": null,
        "current_time": "9:14 PM - Sunday Dec 07, 2025",
        "push_allowed": true,
        "agents": null,
        "last_seen_type": null,
        "active_brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "display_name": "Abbas Gholavi",
        "abbreviated_display_name": "Abbas",
        "online_state": "Offline",
        "has_password": true
      }
    ],
    "associations": [
      {
        "id": "351747fd-bd4b-4fdf-ba36-0d8f8a72cb9b",
        "created_at": 1765163657.440047,
        "updated_at": 1765163657.440047,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "listing",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "index": null,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      }
    ],
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "type": "crm_task",
    "contacts": [],
    "deals": [],
    "listings": [
      "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
    ],
    "emails": []
  }
}

Create a new task with relative reminder

Create a new task with relative reminder
POST/crm/tasks

Reminders can be specified when creating the task.

Example URI

POST /crm/tasks
URI Parameters
HideShow
associations
array (optional) Example: crm_task.reminders
Request
HideShow
Body
{
  "title": "Task with relative reminder",
  "due_date": 1765163654.099,
  "end_date": 1765170854.099,
  "task_type": "Todo",
  "metadata": {
    "template": "<html></html>"
  },
  "reminders": [
    {
      "is_relative": true,
      "timestamp": 1765156454.099
    }
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "68042703-d0ac-4448-ae00-98b3332186bb",
    "created_at": 1765163654.156179,
    "updated_at": 1765163654.156179,
    "deleted_at": null,
    "title": "Task with relative reminder",
    "description": null,
    "due_date": 1765163654.099,
    "end_date": 1765170854.099,
    "status": "PENDING",
    "task_type": "Todo",
    "all_day": false,
    "metadata": {
      "template": "<html></html>"
    },
    "kind": "Task",
    "reminders": [
      {
        "id": "5f584b4e-909d-40a5-befb-fe31833694c0",
        "created_at": 1765163654.156179,
        "updated_at": 1765163654.156179,
        "deleted_at": null,
        "is_relative": true,
        "timestamp": 1765156454.099,
        "task": "68042703-d0ac-4448-ae00-98b3332186bb",
        "type": "reminder"
      }
    ],
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "type": "crm_task"
  }
}

Update a task

Update a task
PUT/crm/tasks/:id

Example URI

PUT /crm/tasks/:id
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
Request
HideShow
Body
{
  "title": "Hello, Task World!",
  "due_date": 1765163654.099,
  "end_date": 1765170854.099,
  "task_type": "Todo",
  "metadata": {
    "template": "<html></html>"
  },
  "status": "DONE"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
    "created_at": 1765163654.156179,
    "updated_at": 1765163654.156179,
    "deleted_at": null,
    "title": "Hello, Task World!",
    "description": null,
    "due_date": 1765163654.099,
    "end_date": 1765170854.099,
    "status": "DONE",
    "task_type": "Todo",
    "all_day": false,
    "metadata": {
      "template": "<html></html>"
    },
    "kind": "Task",
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "type": "crm_task"
  }
}

Re-assign a task

Re-assign a task
PUT/crm/tasks/:id

Example URI

PUT /crm/tasks/:id
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
associations
array (optional) Example: crm_task.assignees
Request
HideShow
Body
{
  "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
  "created_at": 1765163654.156179,
  "updated_at": 1765163654.156179,
  "deleted_at": null,
  "title": "Hello, Task World!",
  "due_date": 1765163654.099,
  "end_date": 1765170854.099,
  "status": "DONE",
  "task_type": "Todo",
  "all_day": false,
  "metadata": {
    "template": "<html></html>"
  },
  "kind": "Task",
  "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
  "type": "crm_task",
  "assignees": [
    "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
    "created_at": 1765163654.156179,
    "updated_at": 1765163654.156179,
    "deleted_at": null,
    "title": "Hello, Task World!",
    "description": null,
    "due_date": 1765163654.099,
    "end_date": 1765170854.099,
    "status": "DONE",
    "task_type": "Todo",
    "all_day": false,
    "metadata": {
      "template": "<html></html>"
    },
    "kind": "Task",
    "assignees": [
      {
        "type": "user",
        "username": null,
        "first_name": "Unit",
        "last_name": "Test",
        "email": "[email protected]",
        "phone_number": "+4368120265807",
        "created_at": 1493115498.770362,
        "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1765163655.314978,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": true,
        "timezone": "America/Chicago",
        "user_type": "Agent",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": false,
        "personal_room": null,
        "brand": null,
        "fake_email": false,
        "features": [
          "Deals"
        ],
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": true,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "current_time": "9:14 PM - Sunday Dec 07, 2025",
        "push_allowed": true,
        "agents": [
          {
            "id": "f279d248-9c84-48d9-b541-6437459b2b4f",
            "email": "[email protected]",
            "mlsid": "00920130",
            "fax": "(972) 264-4703",
            "full_name": "Gholi Sweet",
            "first_name": "Gholi",
            "last_name": "Sweet",
            "middle_name": null,
            "phone_number": "(972) 264-4703",
            "nar_number": "797500044",
            "office_mui": "15512742",
            "status": "Active",
            "office_mlsid": "RCHT01X",
            "work_phone": "(469) 358-8080",
            "generational_name": null,
            "matrix_unique_id": "155155530",
            "updated_at": 1765163654.254344,
            "deleted_at": null,
            "created_at": 1765163654.254344,
            "mls": "NTREIS",
            "license_number": null,
            "designation": null,
            "nrds": "01053140",
            "type": "agent",
            "office_id": null,
            "secret_questions": [
              "(972) XXX-XX03",
              "jewellxxxxxxxxxxxxxal.net",
              "(469) XXX-XX80"
            ]
          }
        ],
        "last_seen_type": null,
        "active_brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      }
    ],
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "type": "crm_task"
  }
}

Update a task, add a fixed reminder

Update a task, add a fixed reminder
PUT/crm/tasks/:id

All reminders should be sent when requesting an update. New ones will be added and omitted ones are deleted.

Example URI

PUT /crm/tasks/:id
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
associations
array (optional) Example: crm_task.reminders
Request
HideShow
Body
{
  "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
  "created_at": 1765163654.156179,
  "updated_at": 1765163654.156179,
  "deleted_at": null,
  "title": "Hello, Task World!",
  "due_date": 1765163654.099,
  "end_date": 1765170854.099,
  "status": "DONE",
  "task_type": "Todo",
  "all_day": false,
  "metadata": {
    "template": "<html></html>"
  },
  "kind": "Task",
  "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
  "type": "crm_task",
  "reminders": [
    {
      "is_relative": false,
      "timestamp": 1765160054.099
    }
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
    "created_at": 1765163654.156179,
    "updated_at": 1765163654.156179,
    "deleted_at": null,
    "title": "Hello, Task World!",
    "description": null,
    "due_date": 1765163654.099,
    "end_date": 1765170854.099,
    "status": "DONE",
    "task_type": "Todo",
    "all_day": false,
    "metadata": {
      "template": "<html></html>"
    },
    "kind": "Task",
    "reminders": [
      {
        "id": "56926eb8-c0f8-4db9-8cab-dd262d5a6c54",
        "created_at": 1765163654.156179,
        "updated_at": 1765163654.156179,
        "deleted_at": null,
        "is_relative": false,
        "timestamp": 1765160054.099,
        "task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "type": "reminder"
      }
    ],
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "type": "crm_task"
  }
}

Get all associated records

Get all associated records
GET/crm/tasks/:id/associations

You don’t need to pass associations for crm_association model in query args.

Example URI

GET /crm/tasks/:id/associations
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
associations
array (optional) Example: crm_association.listing,crm_association.contact
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "351747fd-bd4b-4fdf-ba36-0d8f8a72cb9b",
      "created_at": 1765163657.440047,
      "updated_at": 1765163657.440047,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "association_type": "listing",
      "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "contact": null,
      "listing": {
        "type": "listing",
        "id": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
        "property_id": "e88fac6a-f7ec-11e4-b318-0a95648eeb58",
        "created_at": 1431355770.035252,
        "updated_at": 1438634599.795186,
        "price": 498000,
        "matrix_unique_id": "52656456",
        "original_price": 519000,
        "last_price": 519000,
        "status": "Sold",
        "association_fee": null,
        "mls_number": "13103256",
        "association_fee_frequency": "",
        "association_fee_includes": "",
        "unexempt_taxes": null,
        "financing_proposed": "Cash,Conventional",
        "list_office_mui": "15514377",
        "list_office_mls_id": "WBSHRT01",
        "list_office_name": "Skylark Realtors",
        "list_office_phone": "(972) 965-6518",
        "possession": "Closing/Funding",
        "co_list_office_mui": "0",
        "co_list_office_mls_id": "",
        "co_list_office_name": "",
        "co_list_office_phone": "",
        "selling_office_mui": "15510668",
        "selling_office_mls_id": "PRGRP01",
        "selling_office_name": "Premier Group, REALTORS",
        "selling_office_phone": "(214) 944-4444",
        "co_selling_office_mui": "0",
        "co_selling_office_mls_id": "",
        "co_selling_office_name": "",
        "co_selling_office_phone": "",
        "list_agent_mui": "15555015",
        "list_agent_direct_work_phone": "(972) 965-6518",
        "list_agent_email": "[email protected]",
        "list_agent_full_name": "Anna K. Short",
        "list_agent_mls_id": "0534782",
        "co_list_agent_mui": "15515828",
        "co_list_agent_direct_work_phone": "(972) 212-9954",
        "co_list_agent_email": "",
        "co_list_agent_full_name": "William B. Short Jr.",
        "co_list_agent_mls_id": "0120894",
        "selling_agent_mui": "15525897",
        "selling_agent_direct_work_phone": "(214) 908-9008",
        "selling_agent_email": "[email protected]",
        "selling_agent_full_name": "Leeann Derdeyn",
        "selling_agent_mls_id": "0398378",
        "co_selling_agent_mui": "0",
        "co_selling_agent_direct_work_phone": "",
        "co_selling_agent_email": "",
        "co_selling_agent_full_name": "",
        "co_selling_agent_mls_id": "",
        "listing_agreement": "Exclusive Right to Sell/Lease",
        "mls_area_major": "DALLAS EAST (12)",
        "mls_area_minor": "EAST DALLAS (11)",
        "mls_name": "North Texas Real Estate Information Systems",
        "matrix_modified_dt": "2015-08-03T15:28:20.083Z",
        "showing_instructions_type": "Appointment (Appt Svc only),Centralized Showing Service",
        "tax_legal_description": "",
        "keybox_type": "Blue iBox",
        "keybox_number": "51950330",
        "close_date": 1431043200,
        "close_price": 478000,
        "deleted_at": null,
        "dom": null,
        "cdom": null,
        "buyers_agency_commission": "3%",
        "sub_agency_commission": "0%",
        "list_date": 1425189600,
        "showing_instructions": null,
        "appointment_phone": null,
        "appointment_phone_ext": null,
        "appointment_call": null,
        "occupancy": null,
        "private_remarks": null,
        "photos_checked_at": null,
        "application_fee_yn": null,
        "revision": null,
        "mls": "NTREIS",
        "transaction_type": "Unknown",
        "usage_type": "Unknown",
        "structure_type": "Unknown",
        "original_mls_property_type": null,
        "original_mls_property_subtype": null,
        "original_mls_status": null,
        "is_address_public": true,
        "parcel_number": null,
        "public_display": true,
        "annual_tax": null,
        "virtual_tour": null,
        "sub_agency_offered": null,
        "transaction_broker_commission": null,
        "compensation_based_on": null,
        "co_list_agent2_mui": null,
        "co_list_agent2_direct_work_phone": null,
        "co_list_agent2_email": null,
        "co_list_agent2_full_name": null,
        "co_list_agent2_mls_id": null,
        "co_list_agent3_mui": null,
        "co_list_agent3_direct_work_phone": null,
        "co_list_agent3_email": null,
        "co_list_agent3_full_name": null,
        "co_list_agent3_mls_id": null,
        "co_selling_agent2_mui": null,
        "co_selling_agent2_direct_work_phone": null,
        "co_selling_agent2_email": null,
        "co_selling_agent2_full_name": null,
        "co_selling_agent2_mls_id": null,
        "co_selling_agent3_mui": null,
        "co_selling_agent3_direct_work_phone": null,
        "co_selling_agent3_email": null,
        "co_selling_agent3_full_name": null,
        "co_selling_agent3_mls_id": null,
        "land_tenure": null,
        "currency": "USD",
        "office_exclusive": false,
        "mls_display_name": "NTREIS",
        "list_agent": null,
        "co_list_agent": null,
        "co_list_agent2": null,
        "selling_agent": null,
        "co_selling_agent": null,
        "co_selling_agent2": null,
        "favorited_in": null,
        "gallery_image_urls": [
          "http://cdn.rechat.co/52656495.jpg",
          "http://cdn.rechat.co/52656496.jpg",
          "http://cdn.rechat.co/52656497.jpg",
          "http://cdn.rechat.co/52656498.jpg",
          "http://cdn.rechat.co/52656499.jpg",
          "http://cdn.rechat.co/52656500.jpg",
          "http://cdn.rechat.co/52656501.jpg",
          "http://cdn.rechat.co/52656502.jpg",
          "http://cdn.rechat.co/52656503.jpg",
          "http://cdn.rechat.co/52656504.jpg",
          "http://cdn.rechat.co/52656505.jpg",
          "http://cdn.rechat.co/52656506.jpg",
          "http://cdn.rechat.co/52656507.jpg",
          "http://cdn.rechat.co/52656508.jpg",
          "http://cdn.rechat.co/52656509.jpg",
          "http://cdn.rechat.co/52656510.jpg",
          "http://cdn.rechat.co/52656511.jpg",
          "http://cdn.rechat.co/52656512.jpg",
          "http://cdn.rechat.co/52656513.jpg",
          "http://cdn.rechat.co/52656514.jpg",
          "http://cdn.rechat.co/52656515.jpg",
          "http://cdn.rechat.co/52656516.jpg",
          "http://cdn.rechat.co/52656517.jpg",
          "http://cdn.rechat.co/52656518.jpg",
          "http://cdn.rechat.co/52656519.jpg"
        ],
        "open_houses": null,
        "property": {
          "type": "property",
          "id": "e88fac6a-f7ec-11e4-b318-0a95648eeb58",
          "bedroom_count": 3,
          "bathroom_count": 2.1,
          "address_id": "e8207750-f7ec-11e4-b937-0a95648eeb58",
          "description": "Built in 1911 for physician, David L. Bettison, this stately Prairie home is an impeccable example of the arts and crafts style and movement.  Featured on the 2013 Munger Place Home Tour, this intricately restored home boasts a gorgeous kitchen, unusual patterned and inlaid maple floors, richly stained woodwork, an enormous master suite, a charming sleeping porch, three fully updated and modernized bathrooms, and large, landscaped yard.",
          "square_meters": 239.40914158305463,
          "created_at": 1431355761.401436,
          "updated_at": 1438634599.45139,
          "matrix_unique_id": 52656456,
          "property_type": "Residential",
          "property_subtype": "RES-Single Family",
          "lot_square_meters": 0,
          "year_built": null,
          "exterior_features": [
            "Balcony",
            "Covered Deck",
            "Covered Porch(es)",
            "Gutters",
            "Patio Covered",
            "Sprinkler System"
          ],
          "interior_features": [
            "Cable TV Available",
            "Decorative Lighting",
            "Dry Bar",
            "High Speed Internet Available"
          ],
          "fireplace_features": [
            "Brick",
            "Gas Logs"
          ],
          "lot_features": [
            "Interior Lot",
            "Landscaped",
            "Lrg. Backyard Grass"
          ],
          "parking_features": [
            "Front"
          ],
          "pool_features": [],
          "security_features": [
            "Burglar",
            "Carbon Monoxide Detector",
            "Fire/Smoke",
            "Monitored"
          ],
          "parking_spaces_covered_total": 0,
          "half_bathroom_count": 1,
          "full_bathroom_count": 2,
          "heating": [
            "Central Air-Elec",
            "Central Heat-Gas",
            "Zoned"
          ],
          "flooring": [
            "Ceramic Tile",
            "Stone",
            "Wood"
          ],
          "utilities": [
            "Alley",
            "City Sewer",
            "City Water",
            "Concrete",
            "Curbs",
            "Individual Gas Meter",
            "Individual Water Meter"
          ],
          "utilities_other": [],
          "architectural_style": [
            "Prairie"
          ],
          "number_of_stories": 2,
          "number_of_parking_spaces": 0,
          "garage_length": 0,
          "garage_width": 0,
          "number_of_dining_areas": 2,
          "number_of_living_areas": 3,
          "fireplaces_total": 1,
          "lot_number": "14",
          "soil_type": "",
          "construction_materials": "Siding,Wood",
          "foundation_details": "Pier & Beam",
          "roof": "Composition",
          "pool_yn": false,
          "handicap_yn": false,
          "elementary_school_name": "Lipscomb",
          "intermediate_school_name": "",
          "high_school_name": null,
          "junior_high_school_name": "",
          "middle_school_name": "Long",
          "primary_school_name": "",
          "senior_high_school_name": "",
          "school_district": "Dallas ISD",
          "subdivision_name": "Munger Place",
          "appliances_yn": null,
          "green_building_certification": "",
          "green_energy_efficient": "Low Flow Fixtures,Rain / Freeze Sensors",
          "lot_size": 0,
          "lot_size_area": 0,
          "lot_size_dimensions": "56X122",
          "number_of_pets_allowed": null,
          "number_of_units": 0,
          "pets_yn": null,
          "deleted_at": null,
          "furnished_yn": null,
          "fenced_yard_yn": null,
          "block": null,
          "mls": "NTREIS",
          "pets_policy": null,
          "amenities": null,
          "appliances": null,
          "fencing": null,
          "furnished": null,
          "lot_size_area_unit": "Acres",
          "building_area_total": null,
          "basement_bedroom_count": null,
          "address": {
            "title": "",
            "subtitle": "",
            "street_number": "5020",
            "street_name": "Junius",
            "city": "Dallas",
            "state": "Texas",
            "state_code": "TX",
            "postal_code": "75214",
            "neighborhood": "",
            "id": "e8207750-f7ec-11e4-b937-0a95648eeb58",
            "street_suffix": "Street",
            "unit_number": "",
            "country": "United States",
            "country_code": "USA",
            "created_at": 1431355760.671007,
            "updated_at": 1438634599.212481,
            "location_google": {
              "type": "Point",
              "crs": {
                "type": "name",
                "properties": {
                  "name": "EPSG:4326"
                }
              },
              "coordinates": [
                -96.765508,
                32.801221
              ]
            },
            "matrix_unique_id": 52656456,
            "geocoded": null,
            "geo_source": "None",
            "partial_match_google": null,
            "county_or_parish": "Dallas",
            "direction": null,
            "street_dir_prefix": "",
            "street_dir_suffix": "",
            "street_number_searchable": "5020",
            "geo_source_formatted_address_google": "5020 Junius Street, Dallas, TX 75214, USA",
            "geocoded_google": true,
            "geocoded_bing": false,
            "location_bing": null,
            "geo_source_formatted_address_bing": null,
            "geo_confidence_google": null,
            "geo_confidence_bing": null,
            "location": null,
            "approximate": null,
            "corrupted": null,
            "corrupted_google": false,
            "corrupted_bing": null,
            "deleted_at": null,
            "mls": "NTREIS",
            "location_mapbox": null,
            "geocoded_mapbox": null,
            "corrupted_mapbox": null,
            "geo_source_formatted_address_mapbox": null,
            "geo_confidence_mapbox": null,
            "type": "address",
            "full_address": "5020 Junius Street Dallas, TX 75214",
            "street_address": "5020 Junius Street"
          }
        },
        "user_listing_notification_setting": null,
        "cover_image_url": "http://cdn.rechat.co/52656495.jpg",
        "_url": "https://irish.rechat.com/dashboard/mls/edb5195a-f7ec-11e4-bc76-0a95648eeb58",
        "formatted": {
          "type": "formatted_listing",
          "price": {
            "type": "formatted_attribute",
            "text": "$478,000",
            "text_no_label": "478,000",
            "value": 478000
          },
          "original_price": {
            "type": "formatted_attribute",
            "text": "$498,000",
            "text_no_label": "498,000",
            "value": 498000
          },
          "area": {
            "type": "formatted_attribute",
            "text": "2,577 SQFT",
            "text_no_label": "2,577",
            "value": 2577
          },
          "square_feet": {
            "type": "formatted_attribute",
            "text": "2,577 SQFT",
            "text_no_label": "2,577",
            "value": 2577
          },
          "square_meters": {
            "type": "formatted_attribute",
            "text": "239 SQM",
            "text_no_label": "239",
            "value": 239
          },
          "lot_size_square_feet": {
            "type": "formatted_attribute",
            "text": "0 SQFT",
            "text_no_label": "0",
            "value": 0
          },
          "lot_size_acres": {
            "type": "formatted_attribute",
            "text": "0 Acres",
            "text_no_label": "0",
            "value": 0
          },
          "lot_size_area": {
            "type": "formatted_attribute",
            "text": "0 Acres",
            "text_no_label": "0",
            "value": 0
          },
          "lot_size_square_meters": {
            "type": "formatted_attribute",
            "text": "0 SQM",
            "text_no_label": "0",
            "value": 0
          },
          "building_area_total": {
            "type": "formatted_attribute",
            "text": null,
            "text_no_label": null,
            "value": null
          },
          "bedroom_count": {
            "type": "formatted_attribute",
            "text": "3 Bedrooms",
            "text_no_label": "3",
            "value": 3
          },
          "basement_bedroom_count": {
            "type": "formatted_attribute",
            "text": null,
            "text_no_label": null,
            "value": null
          },
          "bathrooms": {
            "type": "formatted_attribute",
            "text": "2.1 Bathrooms",
            "text_no_label": "2.1",
            "value": "2.1"
          },
          "total_bathroom_count": {
            "type": "formatted_attribute",
            "text": "3 Bathrooms",
            "text_no_label": "3",
            "value": "3"
          },
          "parking_spaces": {
            "type": "formatted_attribute",
            "text": "0 Parking Spaces",
            "text_no_label": "0",
            "value": 0
          },
          "street_address": {
            "type": "formatted_attribute",
            "text": "5020 Junius Street",
            "text_no_label": "5020 Junius Street",
            "value": "5020 Junius Street"
          },
          "full_address": {
            "type": "formatted_attribute",
            "text": "5020 Junius Street Dallas, TX 75214",
            "text_no_label": "5020 Junius Street Dallas, TX 75214",
            "value": "5020 Junius Street Dallas, TX 75214"
          },
          "address_line_2": {
            "type": "formatted_attribute",
            "text": "Dallas, TX 75214",
            "text_no_label": "Dallas, TX 75214",
            "value": "Dallas, TX 75214"
          },
          "region": {
            "type": "formatted_attribute",
            "text": "Texas",
            "text_no_label": "Texas",
            "value": "Texas"
          },
          "city_and_region": {
            "type": "formatted_attribute",
            "text": "Dallas, Texas",
            "text_no_label": "Dallas, Texas",
            "value": "Dallas, Texas"
          },
          "courtesy": {
            "type": "formatted_attribute",
            "text": "Listing courtesy of Anna K. Short of Skylark Realtors ([email protected] | (972) 965-6518)\nWilliam B. Short Jr. ((972) 212-9954)\nSold by Leeann Derdeyn of Premier Group, REALTORS ([email protected] | (214) 908-9008)",
            "text_no_label": "Listing courtesy of Anna K. Short of Skylark Realtors ([email protected] | (972) 965-6518)\nWilliam B. Short Jr. ((972) 212-9954)\nSold by Leeann Derdeyn of Premier Group, REALTORS ([email protected] | (214) 908-9008)",
            "value": "Listing courtesy of Anna K. Short of Skylark Realtors ([email protected] | (972) 965-6518)\nWilliam B. Short Jr. ((972) 212-9954)\nSold by Leeann Derdeyn of Premier Group, REALTORS ([email protected] | (214) 908-9008)"
          },
          "listed_by": {
            "type": "formatted_attribute",
            "text": "Listed by: Anna K. Short | Skylark Realtors",
            "text_no_label": "Anna K. Short | Skylark Realtors",
            "value": "Anna K. Short | Skylark Realtors"
          },
          "listed_by_email": {
            "type": "formatted_attribute",
            "text": "[email protected]",
            "text_no_label": "[email protected]",
            "value": "[email protected]"
          },
          "listed_by_phone": {
            "type": "formatted_attribute",
            "text": "(972) 965-6518",
            "text_no_label": "(972) 965-6518",
            "value": "(972) 965-6518"
          },
          "unexempt_taxes": {
            "type": "formatted_attribute",
            "text": null,
            "text_no_label": null,
            "value": null
          },
          "land_tenure": {
            "type": "formatted_attribute",
            "text": null,
            "text_no_label": null,
            "value": null
          }
        }
      },
      "index": null,
      "metadata": {
        "origin": "rechat"
      },
      "type": "crm_association"
    },
    {
      "id": "8b1065c2-b546-4710-a80f-27a7a79ebcd1",
      "created_at": 1765163657.826045,
      "updated_at": 1765163657.826045,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "association_type": "contact",
      "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "contact": {
        "id": "a33dc03d-a489-40e3-8452-3be8fb777182",
        "display_name": "Johnny",
        "partner_name": "Jane Doe",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "brand_id": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "sort_field": "Johnny",
        "last_touch": null,
        "last_touch_action": null,
        "next_touch": null,
        "touch_freq": null,
        "ios_address_book_id": null,
        "android_address_book_id": null,
        "created_at": 1765163655.419818,
        "updated_at": 1765163654.156179,
        "deleted_at": null,
        "created_for": "direct_request",
        "updated_for": "direct_request",
        "deleted_for": null,
        "title": null,
        "first_name": "John",
        "partner_first_name": "Jane",
        "middle_name": "M.",
        "last_name": "Doe",
        "partner_last_name": "Doe",
        "marketing_name": null,
        "nickname": "Johnny",
        "email": "[email protected]",
        "primary_email": "[email protected]",
        "emails": [
          "[email protected]"
        ],
        "parked": false,
        "partner_email": "[email protected]",
        "phone_number": "+989124834198",
        "primary_phone_number": "+989124834198",
        "phone_numbers": [
          "+989124834198"
        ],
        "company": "Rechat",
        "birthday": "1970-01-12T00:00:00.000Z",
        "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
        "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
        "job_title": "Contact Test Subject",
        "source_type": "ExplicitlyCreated",
        "source": null,
        "website": [
          "http://www.gholi.com"
        ],
        "tags": [
          "poo",
          "foo",
          "New"
        ],
        "address": [
          {
            "city": "Dallas",
            "full": "Street, Dallas Texas 72890",
            "name": "Street",
            "type": "stdaddr",
            "extra": "Office",
            "line1": "Street",
            "line2": "Dallas Texas 72890",
            "state": "Texas",
            "country": "US",
            "postcode": "72890"
          }
        ],
        "type": "contact"
      },
      "listing": null,
      "index": 1,
      "metadata": {
        "origin": "rechat"
      },
      "type": "crm_association"
    },
    {
      "id": "29da8529-fe57-40f8-9ae7-ff71a859901f",
      "created_at": 1765163658.055264,
      "updated_at": 1765163658.055264,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "association_type": "contact",
      "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "contact": {
        "id": "f2999691-8542-4e3c-9ecb-36d298e36729",
        "display_name": "Kate Bell",
        "partner_name": null,
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "brand_id": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "sort_field": "Bell Kate",
        "last_touch": null,
        "last_touch_action": null,
        "next_touch": null,
        "touch_freq": null,
        "ios_address_book_id": "177C371E-701D-42F8-A03B-C61CA31627F6",
        "android_address_book_id": null,
        "created_at": 1765163655.695406,
        "updated_at": 1765163654.156179,
        "deleted_at": null,
        "created_for": "import_json",
        "updated_for": "import_json",
        "deleted_for": null,
        "title": null,
        "first_name": "Kate",
        "partner_first_name": null,
        "middle_name": null,
        "last_name": "Bell",
        "partner_last_name": null,
        "marketing_name": null,
        "nickname": null,
        "email": "[email protected]",
        "primary_email": "[email protected]",
        "emails": [
          "[email protected]"
        ],
        "parked": false,
        "partner_email": null,
        "phone_number": "(415) 555-3695",
        "primary_phone_number": "(415) 555-3695",
        "phone_numbers": [
          "(415) 555-3695",
          "(555) 564-8583"
        ],
        "company": null,
        "birthday": "1978-01-13T00:00:00.000Z",
        "profile_image_url": null,
        "cover_image_url": null,
        "job_title": null,
        "source_type": "IOSAddressBook",
        "source": null,
        "website": null,
        "tags": null,
        "address": [
          {
            "city": "Hillsborough",
            "full": "165 Davis Street, Hillsborough CA 94010",
            "name": "Davis",
            "type": "stdaddr",
            "line1": "165 Davis Street",
            "line2": "Hillsborough CA 94010",
            "state": "CA",
            "suftype": "Street",
            "postcode": "94010",
            "house_num": "165"
          }
        ],
        "type": "contact"
      },
      "listing": null,
      "index": null,
      "metadata": {
        "origin": "rechat"
      },
      "type": "crm_association"
    },
    {
      "id": "3943d6d9-7849-4bc3-b10c-0a34aecbb0fc",
      "created_at": 1765163658.055347,
      "updated_at": 1765163658.055347,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "association_type": "contact",
      "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "contact": {
        "id": "91c94064-4290-4005-9bfa-24abe4f5341a",
        "display_name": "Daniel Higgins",
        "partner_name": null,
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "brand_id": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "sort_field": "Higgins Daniel",
        "last_touch": null,
        "last_touch_action": null,
        "next_touch": null,
        "touch_freq": null,
        "ios_address_book_id": "AB211C5F-9EC9-429F-9466-B9382FF61035",
        "android_address_book_id": null,
        "created_at": 1765163655.695548,
        "updated_at": 1765163654.156179,
        "deleted_at": null,
        "created_for": "import_json",
        "updated_for": "import_json",
        "deleted_for": null,
        "title": null,
        "first_name": "Daniel",
        "partner_first_name": null,
        "middle_name": null,
        "last_name": "Higgins",
        "partner_last_name": null,
        "marketing_name": null,
        "nickname": null,
        "email": "[email protected]",
        "primary_email": "[email protected]",
        "emails": [
          "[email protected]"
        ],
        "parked": false,
        "partner_email": null,
        "phone_number": "(408) 555-3514",
        "primary_phone_number": "(408) 555-3514",
        "phone_numbers": [
          "(408) 555-3514",
          "(408) 555-5270",
          "555-478-7672"
        ],
        "company": null,
        "birthday": null,
        "profile_image_url": null,
        "cover_image_url": null,
        "job_title": null,
        "source_type": "IOSAddressBook",
        "source": null,
        "website": null,
        "tags": null,
        "address": [
          {
            "city": "Corte Madera",
            "full": "322 Laguna Street, Corte Madera CA 94925",
            "name": "Laguna",
            "type": "stdaddr",
            "line1": "322 Laguna Street",
            "line2": "Corte Madera CA 94925",
            "state": "CA",
            "suftype": "Street",
            "postcode": "94925",
            "house_num": "322"
          }
        ],
        "type": "contact"
      },
      "listing": null,
      "index": null,
      "metadata": {
        "origin": "rechat"
      },
      "type": "crm_association"
    }
  ],
  "info": {
    "count": 4,
    "total": 0
  }
}

Add an associated record

Add an associated record
POST/crm/tasks/:id/associations

Example URI

POST /crm/tasks/:id/associations
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
associations
array (optional) Example: crm_association.contact
Request
HideShow
Body
{
  "association_type": "contact",
  "contact": "a33dc03d-a489-40e3-8452-3be8fb777182",
  "index": 1,
  "metadata": {
    "note": "Hey, this is a note"
  }
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "8b1065c2-b546-4710-a80f-27a7a79ebcd1",
    "created_at": 1765163657.826045,
    "updated_at": 1765163657.826045,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "association_type": "contact",
    "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
    "contact": {
      "id": "a33dc03d-a489-40e3-8452-3be8fb777182",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "brand_id": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1765163655.419818,
      "updated_at": 1765163654.156179,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "index": 1,
    "metadata": {
      "note": "Hey, this is a note"
    },
    "type": "crm_association"
  }
}

Bulk add associated records

Bulk add associated records
PUT/crm/tasks/:id

Example URI

PUT /crm/tasks/:id
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
associations
array (optional) Example: crm_association.contact,crm_task.associations
Request
HideShow
Body
{
  "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
  "created_at": 1765163654.156179,
  "updated_at": 1765163654.156179,
  "deleted_at": null,
  "title": "Hello, Task World!",
  "due_date": 1765163654.099,
  "end_date": 1765170854.099,
  "status": "DONE",
  "task_type": "Todo",
  "all_day": false,
  "metadata": {
    "template": "<html></html>"
  },
  "kind": "Task",
  "associations": [
    {
      "id": "8b1065c2-b546-4710-a80f-27a7a79ebcd1",
      "created_at": 1765163657.826045,
      "updated_at": 1765163657.826045,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "association_type": "contact",
      "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "contact": "a33dc03d-a489-40e3-8452-3be8fb777182",
      "listing": null,
      "index": 1,
      "metadata": {
        "origin": "rechat"
      },
      "type": "crm_association"
    },
    {
      "id": "351747fd-bd4b-4fdf-ba36-0d8f8a72cb9b",
      "created_at": 1765163657.440047,
      "updated_at": 1765163657.440047,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
      "association_type": "listing",
      "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
      "contact": null,
      "listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
      "index": null,
      "metadata": {
        "origin": "rechat"
      },
      "type": "crm_association"
    },
    {
      "association_type": "contact",
      "contact": "f2999691-8542-4e3c-9ecb-36d298e36729",
      "metadata": {
        "origin": "rechat"
      }
    },
    {
      "association_type": "contact",
      "contact": "91c94064-4290-4005-9bfa-24abe4f5341a",
      "metadata": {
        "origin": "rechat"
      }
    }
  ],
  "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
  "type": "crm_task",
  "contacts": [
    "a33dc03d-a489-40e3-8452-3be8fb777182"
  ],
  "deals": [],
  "listings": [
    "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
  ],
  "emails": []
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
    "created_at": 1765163654.156179,
    "updated_at": 1765163654.156179,
    "deleted_at": null,
    "title": "Hello, Task World!",
    "description": null,
    "due_date": 1765163654.099,
    "end_date": 1765170854.099,
    "status": "DONE",
    "task_type": "Todo",
    "all_day": false,
    "metadata": {
      "template": "<html></html>"
    },
    "kind": "Task",
    "associations": [
      {
        "id": "8b1065c2-b546-4710-a80f-27a7a79ebcd1",
        "created_at": 1765163657.826045,
        "updated_at": 1765163657.826045,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "contact",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "contact": {
          "id": "a33dc03d-a489-40e3-8452-3be8fb777182",
          "display_name": "Johnny",
          "partner_name": "Jane Doe",
          "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "brand_id": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "sort_field": "Johnny",
          "last_touch": null,
          "last_touch_action": null,
          "next_touch": null,
          "touch_freq": null,
          "ios_address_book_id": null,
          "android_address_book_id": null,
          "created_at": 1765163655.419818,
          "updated_at": 1765163654.156179,
          "deleted_at": null,
          "created_for": "direct_request",
          "updated_for": "direct_request",
          "deleted_for": null,
          "title": null,
          "first_name": "John",
          "partner_first_name": "Jane",
          "middle_name": "M.",
          "last_name": "Doe",
          "partner_last_name": "Doe",
          "marketing_name": null,
          "nickname": "Johnny",
          "email": "[email protected]",
          "primary_email": "[email protected]",
          "emails": [
            "[email protected]"
          ],
          "parked": false,
          "partner_email": "[email protected]",
          "phone_number": "+989124834198",
          "primary_phone_number": "+989124834198",
          "phone_numbers": [
            "+989124834198"
          ],
          "company": "Rechat",
          "birthday": "1970-01-12T00:00:00.000Z",
          "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
          "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
          "job_title": "Contact Test Subject",
          "source_type": "ExplicitlyCreated",
          "source": null,
          "website": [
            "http://www.gholi.com"
          ],
          "tags": [
            "poo",
            "foo",
            "New"
          ],
          "address": [
            {
              "city": "Dallas",
              "full": "Street, Dallas Texas 72890",
              "name": "Street",
              "type": "stdaddr",
              "extra": "Office",
              "line1": "Street",
              "line2": "Dallas Texas 72890",
              "state": "Texas",
              "country": "US",
              "postcode": "72890"
            }
          ],
          "type": "contact"
        },
        "index": 1,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      },
      {
        "id": "351747fd-bd4b-4fdf-ba36-0d8f8a72cb9b",
        "created_at": 1765163657.440047,
        "updated_at": 1765163657.440047,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "listing",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "contact": null,
        "index": null,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      },
      {
        "id": "29da8529-fe57-40f8-9ae7-ff71a859901f",
        "created_at": 1765163658.055264,
        "updated_at": 1765163658.055264,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "contact",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "contact": {
          "id": "f2999691-8542-4e3c-9ecb-36d298e36729",
          "display_name": "Kate Bell",
          "partner_name": null,
          "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "brand_id": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "sort_field": "Bell Kate",
          "last_touch": null,
          "last_touch_action": null,
          "next_touch": null,
          "touch_freq": null,
          "ios_address_book_id": "177C371E-701D-42F8-A03B-C61CA31627F6",
          "android_address_book_id": null,
          "created_at": 1765163655.695406,
          "updated_at": 1765163654.156179,
          "deleted_at": null,
          "created_for": "import_json",
          "updated_for": "import_json",
          "deleted_for": null,
          "title": null,
          "first_name": "Kate",
          "partner_first_name": null,
          "middle_name": null,
          "last_name": "Bell",
          "partner_last_name": null,
          "marketing_name": null,
          "nickname": null,
          "email": "[email protected]",
          "primary_email": "[email protected]",
          "emails": [
            "[email protected]"
          ],
          "parked": false,
          "partner_email": null,
          "phone_number": "(415) 555-3695",
          "primary_phone_number": "(415) 555-3695",
          "phone_numbers": [
            "(415) 555-3695",
            "(555) 564-8583"
          ],
          "company": null,
          "birthday": "1978-01-13T00:00:00.000Z",
          "profile_image_url": null,
          "cover_image_url": null,
          "job_title": null,
          "source_type": "IOSAddressBook",
          "source": null,
          "website": null,
          "tags": null,
          "address": [
            {
              "city": "Hillsborough",
              "full": "165 Davis Street, Hillsborough CA 94010",
              "name": "Davis",
              "type": "stdaddr",
              "line1": "165 Davis Street",
              "line2": "Hillsborough CA 94010",
              "state": "CA",
              "suftype": "Street",
              "postcode": "94010",
              "house_num": "165"
            }
          ],
          "type": "contact"
        },
        "index": null,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      },
      {
        "id": "3943d6d9-7849-4bc3-b10c-0a34aecbb0fc",
        "created_at": 1765163658.055347,
        "updated_at": 1765163658.055347,
        "deleted_at": null,
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
        "association_type": "contact",
        "crm_task": "736ddda0-f1c0-49e6-8aa7-9d3bef095f42",
        "contact": {
          "id": "91c94064-4290-4005-9bfa-24abe4f5341a",
          "display_name": "Daniel Higgins",
          "partner_name": null,
          "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "brand_id": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
          "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "sort_field": "Higgins Daniel",
          "last_touch": null,
          "last_touch_action": null,
          "next_touch": null,
          "touch_freq": null,
          "ios_address_book_id": "AB211C5F-9EC9-429F-9466-B9382FF61035",
          "android_address_book_id": null,
          "created_at": 1765163655.695548,
          "updated_at": 1765163654.156179,
          "deleted_at": null,
          "created_for": "import_json",
          "updated_for": "import_json",
          "deleted_for": null,
          "title": null,
          "first_name": "Daniel",
          "partner_first_name": null,
          "middle_name": null,
          "last_name": "Higgins",
          "partner_last_name": null,
          "marketing_name": null,
          "nickname": null,
          "email": "[email protected]",
          "primary_email": "[email protected]",
          "emails": [
            "[email protected]"
          ],
          "parked": false,
          "partner_email": null,
          "phone_number": "(408) 555-3514",
          "primary_phone_number": "(408) 555-3514",
          "phone_numbers": [
            "(408) 555-3514",
            "(408) 555-5270",
            "555-478-7672"
          ],
          "company": null,
          "birthday": null,
          "profile_image_url": null,
          "cover_image_url": null,
          "job_title": null,
          "source_type": "IOSAddressBook",
          "source": null,
          "website": null,
          "tags": null,
          "address": [
            {
              "city": "Corte Madera",
              "full": "322 Laguna Street, Corte Madera CA 94925",
              "name": "Laguna",
              "type": "stdaddr",
              "line1": "322 Laguna Street",
              "line2": "Corte Madera CA 94925",
              "state": "CA",
              "suftype": "Street",
              "postcode": "94925",
              "house_num": "322"
            }
          ],
          "type": "contact"
        },
        "index": null,
        "metadata": {
          "origin": "rechat"
        },
        "type": "crm_association"
      }
    ],
    "brand": "4df8da09-d50a-43c4-9e61-aadaafd401f5",
    "type": "crm_task",
    "contacts": [
      "a33dc03d-a489-40e3-8452-3be8fb777182",
      "f2999691-8542-4e3c-9ecb-36d298e36729",
      "91c94064-4290-4005-9bfa-24abe4f5341a"
    ],
    "deals": [],
    "listings": [
      "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
    ],
    "emails": []
  }
}

Remove an association

Remove an association
DELETE/crm/tasks/:id/associations/:id

Example URI

DELETE /crm/tasks/:id/associations/:id
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
association
string (required) Example: 8b1065c2-b546-4710-a80f-27a7a79ebcd1
Response  204

Bulk remove associations

Bulk remove associations
DELETE/crm/tasks/:id/associations

Example URI

DELETE /crm/tasks/:id/associations
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
ids
string (required) Example: f2999691-8542-4e3c-9ecb-36d298e36729,91c94064-4290-4005-9bfa-24abe4f5341a
Response  204

Deleting a task

Deleting a task
DELETE/crm/tasks/:id

Example URI

DELETE /crm/tasks/:id
URI Parameters
HideShow
id
string (required) Example: 736ddda0-f1c0-49e6-8aa7-9d3bef095f42
Response  204

Generated by aglio on 08 Dec 2025