---
title: "Get checklists with asset tasks"
method: GET
path: "/checklists/taskslist"
tags: ["CheckLists"]
---

# Get checklists with asset tasks

`GET /checklists/taskslist`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/checklists/taskslist`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/checklists/taskslist/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves checklists of the **Asset Task** type along with their parameters and task details. Such checklists contain asset-related tasks that a technician is prompted to complete when working on a service request.
            <br />You can filter checklists by:
             • **Trade**. Specify either `tradeid` or `tradeName`.
             • **Category**. Enter either `categoryid` or `categoryName`.
             • **Location**. Provide either `locationId` or `storeId` if the feature that allows creating checklists for specific locations is enabled for a subscriber.
             • **Checklist**. Pass either `checklistid` or `checkListName` to get a specific checklist, and ignore other parameters.
            <br />Providers should pass `subscriberId` to retrieve checklists created by the desired subscriber.
            <br />Navigate to ServiceChannel University to find out [how subscribers can configure checklists](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/655425975/Configuring+Checklists).

## Query parameters

- `tradeid` integer
- `checklistid` integer
- `categoryid` integer
- `subscriberId` integer
- `tradeName` string
- `checkListName` string
- `categoryName` string
- `locationId` integer
- `storeId` string
- `providerId` integer

## Response `200`

The requested asset task checklists are in the response.

- ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListWithTasksExtendedResponse: Represents an extended response containing the details of a checklist with associated asset tasks.
  - `ChecklistWithTasks` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListWithTasksResponse[]: Gets or sets a collection of asset task checklists. Each checklist contains details about its parameters and the configured asset-related tasks.
    - `ChecklistName` string: Gets or sets the name of the checklist.
    - `Id` integer: Gets or sets the unique identifier of the checklist.
    - `IsActive` boolean: Gets or sets a value indicating whether the checklist is active.
    - `CreatedDate` string, date-time: Gets or sets the date and time when the checklist was created.
    - `UpdatedDate` string, date-time: Gets or sets the date and time when the checklist was last updated.
    - `CreatedBy` integer: Gets or sets the user ID of the employee who created the checklist.
    - `UpdatedBy` integer: Gets or sets the user ID of the employee who last updated the checklist.
    - `Tasks` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesChecklistTaskResponse[]: Gets or sets a collection of asset-related tasks configured for the checklist.
      - `Id` integer: Gets or sets the unique identifier of the asset task.
      - `CheckListId` integer: Gets or sets the identifier of the checklist to which the asset task belongs.
      - `TypeId` integer: Gets or sets the identifier of the asset type for which the task is configured.
      - `TaskTypeId` 'AssetTask': Gets or sets the identifier of the asset task type.
      - `TaskTypeName` string: Gets or sets the name of the asset task type.
      - `Name` string: Gets or sets the name of the asset task.
      - `Description` string: Gets or sets the description of the asset task.
      - `IsActive` boolean: Gets or sets a value indicating whether the asset task is active.

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 503 — Bad Request; Subscriber Id should be provided if the api method is called by provider 503 — A trade can be specified with only one parameter: either tradeId or tradeName 503 — A category can be specified with only one parameter: either categoryId or categoryName 503 — A checkList can be specified with only one parameter: either checkListId or checkListName 503 — A location can be specified with only one parameter: either locationId or storeId
- `401`: The request is not authorized. <br/>Error codes: 504 — API call rejected by security permissions
- `500`: The server was unable to complete the request due to an internal error.

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)