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": "0dd701d1-af55-42f8-87f1-f6943d6f7854",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "d6e8996e-be10-45d5-8247-69d8ad69dff0",
"Section": {
"TaskTypeSectionId": "acf2f39f-20ba-48f4-85dd-aeeb62263d12",
"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": "1e171fb5-a378-4290-bb8a-4d325e16bde1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3781dbfb-fd85-4402-a961-14b811082ecf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "612d2881-def8-4df2-bdd3-e810ee0f5bac",
"CreateDate": "2025-06-30T13:57:17.7189183-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T13:57:17.7189183-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "d6e8996e-be10-45d5-8247-69d8ad69dff0",
"Section": {
"TaskTypeSectionId": "acf2f39f-20ba-48f4-85dd-aeeb62263d12",
"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": "1e171fb5-a378-4290-bb8a-4d325e16bde1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3781dbfb-fd85-4402-a961-14b811082ecf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "612d2881-def8-4df2-bdd3-e810ee0f5bac",
"CreateDate": "2025-06-30T13:57:17.7189183-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T13:57:17.7189183-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "ca09fee6-cda4-43c0-b9ba-6072d51ba758",
"CreateDate": "2025-06-30T13:57:17.7189183-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T13:57:17.7189183-07:00",
"LastModifiedUser": "sample string 7"
},
{
"TaskTypeId": "0dd701d1-af55-42f8-87f1-f6943d6f7854",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "d6e8996e-be10-45d5-8247-69d8ad69dff0",
"Section": {
"TaskTypeSectionId": "acf2f39f-20ba-48f4-85dd-aeeb62263d12",
"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": "1e171fb5-a378-4290-bb8a-4d325e16bde1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3781dbfb-fd85-4402-a961-14b811082ecf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "612d2881-def8-4df2-bdd3-e810ee0f5bac",
"CreateDate": "2025-06-30T13:57:17.7189183-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T13:57:17.7189183-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "d6e8996e-be10-45d5-8247-69d8ad69dff0",
"Section": {
"TaskTypeSectionId": "acf2f39f-20ba-48f4-85dd-aeeb62263d12",
"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": "1e171fb5-a378-4290-bb8a-4d325e16bde1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3781dbfb-fd85-4402-a961-14b811082ecf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "612d2881-def8-4df2-bdd3-e810ee0f5bac",
"CreateDate": "2025-06-30T13:57:17.7189183-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T13:57:17.7189183-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "ca09fee6-cda4-43c0-b9ba-6072d51ba758",
"CreateDate": "2025-06-30T13:57:17.7189183-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T13:57:17.7189183-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}