API ReferenceTask Field

Query Task Fields

Retrieve a list of TaskFields 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 a Project.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

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

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

datalist of objectsOptional

If the API call succeeded, this will contain the results.