Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
User Tasks

Create a user task

Creates a user task (to-do). Optionally link it to an object record by passing object_name + row_id together. assignee_ids are user IDs (see GET /users). Requires a USER API key.

post/public/v1/tasks

Request body

contentstring required
due_datestring nullable
assignee_idsnumber[]

User IDs (see GET /users).

object_namestring

Link the task to an object record (requires row_id too).

row_idstring

Example request

{
  "content": "Email David Booth about Q3 renewal",
  "due_date": "2026-06-25",
  "assignee_ids": [
    42
  ],
  "object_name": "companies",
  "row_id": "abc123"
}

Response

Created task

idnumber required
contentstring required
due_datestring nullable
completedboolean required
completed_atstring nullable
created_atstring required
updated_atstring required

Example response

{
  "id": 101,
  "content": "Email David Booth about Q3 renewal",
  "due_date": "2026-06-25T00:00:00Z",
  "created_at": "2026-06-01T12:00:00Z",
  "updated_at": "2026-06-01T12:00:00Z",
  "created_by": {
    "id": 42,
    "name": "Alvaro Vargas",
    "email": "alvaro@example.com"
  },
  "completed_by": {
    "id": 42,
    "name": "Alvaro Vargas",
    "email": "alvaro@example.com"
  },
  "assignees": [
    {
      "id": 42,
      "name": "Alvaro Vargas",
      "email": "alvaro@example.com"
    }
  ],
  "related": {
    "object_name": "companies",
    "object_label": "Companies",
    "row_id": "abc123"
  }
}