GET TaskTypes?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves task types for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| take |
Number of task types to retrieve. Default is all task types |
integer |
None. |
| skip |
Number of task types to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the task types before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of task types.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of TaskType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"TaskTypeId": "eac6d070-f5c6-4939-8c69-70d3f261fb2c",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "04975adf-ed15-4cea-a93f-448ada431f67",
"Section": {
"TaskTypeSectionId": "b5f3abc2-eb06-4898-9e8a-813c4f5cb3e1",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "48d60bbe-9ac5-4996-88af-5b56c4642ac7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4b86c7d4-3600-43de-9447-cc91e83a032c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1307689c-bb90-44a0-87ae-05e91a8c1393",
"CreateDate": "2025-07-02T16:53:49.2128481-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-02T16:53:49.2128481-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
},
{
"TaskTypeFieldId": "04975adf-ed15-4cea-a93f-448ada431f67",
"Section": {
"TaskTypeSectionId": "b5f3abc2-eb06-4898-9e8a-813c4f5cb3e1",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "48d60bbe-9ac5-4996-88af-5b56c4642ac7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4b86c7d4-3600-43de-9447-cc91e83a032c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1307689c-bb90-44a0-87ae-05e91a8c1393",
"CreateDate": "2025-07-02T16:53:49.2128481-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-02T16:53:49.2128481-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "d945e27b-a02e-4a4f-8461-44ad074ecd92",
"CreateDate": "2025-07-02T16:53:49.2128481-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-02T16:53:49.2128481-07:00",
"LastModifiedUser": "sample string 7"
},
{
"TaskTypeId": "eac6d070-f5c6-4939-8c69-70d3f261fb2c",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "04975adf-ed15-4cea-a93f-448ada431f67",
"Section": {
"TaskTypeSectionId": "b5f3abc2-eb06-4898-9e8a-813c4f5cb3e1",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "48d60bbe-9ac5-4996-88af-5b56c4642ac7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4b86c7d4-3600-43de-9447-cc91e83a032c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1307689c-bb90-44a0-87ae-05e91a8c1393",
"CreateDate": "2025-07-02T16:53:49.2128481-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-02T16:53:49.2128481-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
},
{
"TaskTypeFieldId": "04975adf-ed15-4cea-a93f-448ada431f67",
"Section": {
"TaskTypeSectionId": "b5f3abc2-eb06-4898-9e8a-813c4f5cb3e1",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "48d60bbe-9ac5-4996-88af-5b56c4642ac7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4b86c7d4-3600-43de-9447-cc91e83a032c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1307689c-bb90-44a0-87ae-05e91a8c1393",
"CreateDate": "2025-07-02T16:53:49.2128481-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-02T16:53:49.2128481-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "eb313a35-4bad-4e36-a80c-e47902d2701e",
"FieldId": "deed6e88-62ac-4e8c-8d14-15590cba8f4e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 11",
"SourceSystemId": "sample string 12"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "d945e27b-a02e-4a4f-8461-44ad074ecd92",
"CreateDate": "2025-07-02T16:53:49.2128481-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-02T16:53:49.2128481-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}