Task Field

Query Task Field Values

GET

Retrieve a list of TaskFieldValues that match an OData formatted query.

A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project.

Query parameters

$topintegerOptional
The number of records to return
$skipintegerOptional
Skips the given number of records and then returns $top records
$filterstringOptional
Filter the expression according to oData queries
$orderbystringOptional
Order collection by this field.
$expandstringOptional
Include related data in the response

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
list of objectsOptional
If the API call succeeded, this will contain the results.
GET
1curl /api/data/tasks/fields/values \
2 -H "Authorization: Bearer <token>"
200
Retrieved
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue",
12 "data": [
13 {
14 "id": "id",
15 "shortId": "shortId",
16 "name": "name",
17 "type": "type",
18 "value": "value",
19 "createdDate": "2024-01-15T09:30:00Z",
20 "modifiedDate": "2024-01-15T09:30:00Z"
21 }
22 ]
23}