List Tasks
Resource URL
Parameters
Table of allowed paramaters.
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
|---|
Handling the response
Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields paramater; see included examples. Underlined values are default.
| id | unsigned | Activity's unique identifier. This can be used to request other endpoints. |
|---|
| title | string | |
|---|
| custom_id | string | |
|---|
| standing | string | active, pending, inactive, etc |
|---|
| billable | unsigned | Total billable minutes |
|---|
| nonbillable | unsigned | Total non-billable minutes |
|---|
| budgeted | unsigned | Total budgeted minutes. |
|---|
| remaining | unsigned | Total remaining minutes |
|---|
| logged | unsigned | Total minutes logged (includes billable and non-billable) |
|---|
| date_created | unix ts | |
|---|
| date_started | unix ts | |
|---|
| date_commenced | unix ts | |
|---|
| date_accepted | unix ts | |
|---|
| date_completed | unix ts | |
|---|
| date_modified | unix ts | |
|---|
| date_due | unix ts | |
|---|
| creator | string | API resource endpoint for the task creator. For example, staff/12 |
|---|
| creator_type | string | The type of creator. For example, staff or affiliation. |
|---|
| creator_id | unsigned | Unique identifier for the creator object. |
|---|
| assignee | unsigned or object | |
|---|
| type | unsigned or object | |
|---|
| status | unsigned or object | |
|---|
| manager | unsigned or object | |
|---|
| contact | unsigned or object | |
|---|
Fields that can be object indicate the field can be requested as a resource. For example.
| Code Block |
|---|
|
GET /tasks/1.json?_fields=assignee |
would return the task's assignee's staff id. Where as,
| Code Block |
|---|
|
GET /tasks/1.json?_fields=assignee(email) |
would return the assignee's staff object, including any optional fields or objects within the parenthesis. In the above examples case, it would return the staff objects default values and optional email value.
Sample Response
| Code Block |
|---|
|
GET /tasks/1.json?_fields=date_created,date_started,assignee(email),type(color) |
| Code Block |
|---|
|
{
"response" : {
"date_created" : "1003327200",
"assignee" : {
"email" : "geoff.mcqueen@affinitylive.com",
"firstname" : "Geoff",
"id" : "1000",
"surname" : "McQueen"
},
"type" : {
"title" : "Default",
"id" : "1"
},
"title" : "Complaints System Database",
"id" : "1",
"date_started" : "1003327200"
},
{
"date_created" : "1017320400",
"assignee" : {
"email" : "adrian@internetrix.com.au",
"firstname" : "Adrian",
"id" : "3",
"surname" : "Smalley"
},
"type" : {
"title" : "Default",
"id" : "1"
},
"title" : "Design Refinement and Tweaking",
"id" : "2",
"date_started" : "1017320400"
},
"meta" : {
"status" : "ok",
"message" : "Everything executed as expected."
}
} |