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": "26d613ce-d093-481e-91c2-a98f539a77c4",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "a76d68c8-6f9f-4e64-b4dc-63386fb64ab3",
"Section": {
"TaskTypeSectionId": "e58144b6-aaa8-420a-92a0-44bb9e48e623",
"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": "b286af9b-7d7f-4ce3-8421-278b2562f516",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e94477e3-7e50-47ed-a1ea-508574b1f55f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3e704c5b-b2fd-4738-a0cf-1be8f7aa0e9b",
"CreateDate": "2025-04-25T15:29:31.6845138-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:29:31.6845138-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"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": "a76d68c8-6f9f-4e64-b4dc-63386fb64ab3",
"Section": {
"TaskTypeSectionId": "e58144b6-aaa8-420a-92a0-44bb9e48e623",
"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": "b286af9b-7d7f-4ce3-8421-278b2562f516",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e94477e3-7e50-47ed-a1ea-508574b1f55f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3e704c5b-b2fd-4738-a0cf-1be8f7aa0e9b",
"CreateDate": "2025-04-25T15:29:31.6845138-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:29:31.6845138-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"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": "5871ac62-786a-45c0-9e77-ec41a36e6108",
"CreateDate": "2025-04-25T15:29:31.6845138-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:29:31.6845138-07:00",
"LastModifiedUser": "sample string 7"
},
{
"TaskTypeId": "26d613ce-d093-481e-91c2-a98f539a77c4",
"Name": "sample string 1",
"Description": "sample string 2",
"CustomStatuses": true,
"Fields": [
{
"TaskTypeFieldId": "a76d68c8-6f9f-4e64-b4dc-63386fb64ab3",
"Section": {
"TaskTypeSectionId": "e58144b6-aaa8-420a-92a0-44bb9e48e623",
"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": "b286af9b-7d7f-4ce3-8421-278b2562f516",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e94477e3-7e50-47ed-a1ea-508574b1f55f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3e704c5b-b2fd-4738-a0cf-1be8f7aa0e9b",
"CreateDate": "2025-04-25T15:29:31.6845138-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:29:31.6845138-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"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": "a76d68c8-6f9f-4e64-b4dc-63386fb64ab3",
"Section": {
"TaskTypeSectionId": "e58144b6-aaa8-420a-92a0-44bb9e48e623",
"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": "b286af9b-7d7f-4ce3-8421-278b2562f516",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e94477e3-7e50-47ed-a1ea-508574b1f55f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3e704c5b-b2fd-4738-a0cf-1be8f7aa0e9b",
"CreateDate": "2025-04-25T15:29:31.6845138-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:29:31.6845138-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7c34da3b-c953-4092-af5c-172917e9629e",
"FieldId": "993cc06e-d029-4393-bfac-36eaf7860ac2",
"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": "5871ac62-786a-45c0-9e77-ec41a36e6108",
"CreateDate": "2025-04-25T15:29:31.6845138-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:29:31.6845138-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}