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": "712069a9-16ba-49e8-9651-ba137b448d86",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "db9fbc4b-ee1e-4078-a6d7-20413e56db42",
"Section": {
"TaskTypeSectionId": "e54898dd-74f2-4c0d-bcc9-3bb66909d6e6",
"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": "100a81e2-5451-4586-84f9-983df447ace2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "499b1ff4-8aac-4a85-8afa-f7bdee0c2b5e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "147b1ca2-59b9-45d6-90d0-d593c0472229",
"CreateDate": "2025-07-14T14:28:03.9787413-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-14T14:28:03.9787413-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "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": "db9fbc4b-ee1e-4078-a6d7-20413e56db42",
"Section": {
"TaskTypeSectionId": "e54898dd-74f2-4c0d-bcc9-3bb66909d6e6",
"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": "100a81e2-5451-4586-84f9-983df447ace2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "499b1ff4-8aac-4a85-8afa-f7bdee0c2b5e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "147b1ca2-59b9-45d6-90d0-d593c0472229",
"CreateDate": "2025-07-14T14:28:03.9787413-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-14T14:28:03.9787413-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "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": "719be803-cfef-45d0-bbb2-336d8139cfa0",
"CreateDate": "2025-07-14T14:28:03.9787413-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-14T14:28:03.9787413-07:00",
"LastModifiedUser": "sample string 7"
},
{
"TaskTypeId": "712069a9-16ba-49e8-9651-ba137b448d86",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "db9fbc4b-ee1e-4078-a6d7-20413e56db42",
"Section": {
"TaskTypeSectionId": "e54898dd-74f2-4c0d-bcc9-3bb66909d6e6",
"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": "100a81e2-5451-4586-84f9-983df447ace2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "499b1ff4-8aac-4a85-8afa-f7bdee0c2b5e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "147b1ca2-59b9-45d6-90d0-d593c0472229",
"CreateDate": "2025-07-14T14:28:03.9787413-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-14T14:28:03.9787413-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "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": "db9fbc4b-ee1e-4078-a6d7-20413e56db42",
"Section": {
"TaskTypeSectionId": "e54898dd-74f2-4c0d-bcc9-3bb66909d6e6",
"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": "100a81e2-5451-4586-84f9-983df447ace2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "499b1ff4-8aac-4a85-8afa-f7bdee0c2b5e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "147b1ca2-59b9-45d6-90d0-d593c0472229",
"CreateDate": "2025-07-14T14:28:03.9787413-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-14T14:28:03.9787413-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "366a95a1-d7c6-43a5-ba56-7bdfb0afc348",
"FieldId": "ec805485-33e3-4525-aa04-f1b9f3b3b8d4",
"FieldName": "sample string 1",
"FieldLable": "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": "719be803-cfef-45d0-bbb2-336d8139cfa0",
"CreateDate": "2025-07-14T14:28:03.9787413-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-14T14:28:03.9787413-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}