v1
latestOpenAPI 3.0.32026-08-0613775357.6 KBassignments
List assignments
Lists the accessible assignments.
get/assignments
Query parameters
per_pageinteger
The maximum number of items to show per response page.
Example:100
pageinteger
The response page to return.
Example:2
fromstring date
Filter on assignments that end after this date.
tostring date
Filter on assignments that start before this date.
with_phasesboolean
If true, include assignments to phases. Otherwise, exclude them.
Response
The accessible assignments.
Example response
{
"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": [
{
"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
}
]
}
}
]
}