Sign in

v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
assignments
assignments_with_subtasks

Create assignment

Creates an assignment.

Typical parameters:

  • user_id
  • assignable_id
  • starts_at
  • ends_at
  • allocation_mode (percent, hours_per_day, fixed) and a value for the respective mode-named property (that is, a property named percent, hours_per_day, or fixed_hours)

Note: You can create subtasks within the assignment by including them in a subtasks array property, like the one in the request body object below.

For subtask-specific operations, see Subtasks.

{
 "user_id": null,
 "assignable_id": 123,
 "ends_at": "2018-06-27",
 "starts_at": "2018-06-21",
 "status_option_id": 1,
 "description": "Build wireframes",
 "note": null,
 "subtasks": [
   {
     "description": "New Task",
     "completed": false
   }
 ]
}
post/assignments

Request body

OR
OR

Example request

{
  "allocation_mode": "percent",
  "percent": 0.2,
  "id": 889,
  "user_id": 5612,
  "assignable_id": 1234,
  "starts_at": "2025-09-17",
  "ends_at": "2025-12-17",
  "repetition_id": 886,
  "created_at": "2025-08-27T12:00:00Z",
  "updated_at": "2025-08-27T12:00:00Z",
  "all_day_assignment": true,
  "bill_rate": 100,
  "bill_rate_id": 58776516,
  "status_option_id": 1234567890,
  "subtasks": [
    {
      "description": "Assess risks"
    }
  ]
}

Response

The new assignment.

OR
OR

Example response

{
  "allocation_mode": "percent",
  "percent": 0.2,
  "id": 889,
  "user_id": 5612,
  "assignable_id": 1234,
  "starts_at": "2025-09-17",
  "ends_at": "2025-12-17",
  "repetition_id": 886,
  "created_at": "2025-08-27T12:00:00Z",
  "updated_at": "2025-08-27T12:00:00Z",
  "all_day_assignment": true,
  "bill_rate": 100,
  "bill_rate_id": 58776516,
  "status_option_id": 1234567890,
  "subtasks": {
    "paging": {
      "per_page": 100,
      "page": 1,
      "previous": "/api/v1/users?per_page=1000&page=1",
      "self": "/api/v1/users?per_page=1000&page=2",
      "next": "/api/v1/users?per_page=1000&page=3"
    },
    "data": [
      {
        "id": 6789012345,
        "assignment_id": 5612,
        "assignable_id": 1234,
        "description": "Assess risks",
        "updated_at": "2025-08-27T12:00:00Z",
        "created_at": "2025-08-27T12:00:00Z",
        "updated_by": 1234567
      }
    ]
  }
}