--- title: "Get standard checklists" method: GET path: "/checklists/detail" tags: ["CheckLists"] --- # Get standard checklists `GET /checklists/detail` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/checklists/detail` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) [Returns standard checklists](/guides/checklists/find-and-filter-checklists/) along with their parameters, configured questions, and answer options.
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.
Providers should pass `subscriberId` to retrieve checklists created by the desired subscriber.
The `NumericInput` and `LessMoreOption` fields in the response are obsolete and should not be used.
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 - `workOrderId` integer ## Response `200` The requested standard checklists are in the response. - ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListDetailExtendedResponse: Represents an extended response containing the details of a standard checklist. - `CheckListDetails` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListDetailResponse[]: Gets or sets a collection of detailed standard checklist objects. Each object includes parameters and configured questions associated with the checklist. - `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. - `Questions` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListDetailQuestionsResponse[]: Gets or sets a collection of questions configured for the checklist. - `Id` integer: Gets or sets the unique identifier of the checklist question. - `CheckListId` integer: Gets or sets the ID of the checklist to which the question belongs. - `Question` string: Gets or sets the question that a technician is prompted to answer when working on a service request. - `ShortDescription` string: Gets or sets the short description, although it's noted as not applicable to checklists. - `AnswerRequired` boolean: Gets or sets a value indicating whether answering this checklist question is mandatory. - `PictureFlag` 'Optional' | 'No' | 'Required': Gets or sets the requirement level for uploading an attachment when answering the question. 0 — Adding an attachment is optional.1 — An attachment is not required.2 — Uploading an attachment is mandatory. - `Sequence` integer: Gets or sets the sequence number, noted as not applicable to checklists. - `QuestionType` 'CheckBox' | 'RadioButton' | 'TextEntry' | 'TriState' | 'NumericInput': Gets or sets the type of the checklist question. 0 — Acknowledgement: Represents an on/off toggle prompting a technician to give a positive or negative response to a question.1 — Selector: Provides multiple configured answer options to choose from.2 — Text Entry: Allows entering a text answer.4 — Numeric Input: Prompts to submit a number as a response. - `CheckListQuestionOptions` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListQuestionOptionResponse[]: Gets or sets the answer options for questions of the Selector type. - `Id` integer: Gets or sets the unique identifier of the answer option for a checklist question of the Selector type. - `Answer` string: Gets or sets the answer option for a checklist question of the Selector type. A technician can select from a list of configured options when answering the question. - `Sequence` integer: Gets or sets the sequence number. This property is not applicable to checklists. - `IsConditionalFollowUp` boolean: Gets or sets a value indicating whether a technician is prompted to add a comment to the selected answer option. A comment is mandatory if answering the checklist question is required. - `ResponseResultInFailure` boolean: Gets or sets a value indicating whether the option for a checklist question of the Selector type results in failure. - `GenerateFollowUpWo` boolean: Generates a follow-up work order. - `AnswerCanPersist` boolean: Gets or sets a value indicating whether the answer to this question can persist. If the answer is persistent, the last submitted response populates on the question. A technician can either opt for the current response or update it. - `CheckListTimingType` 'CheckIn' | 'CheckOut': Gets or sets the checklist segment the question belongs to: 1 — check-in segment, 2 — check-out segment. - `AcknowledgeUrl` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListAcknowledgeUrlResponse - `Url` string - `Required` boolean - `AllowMultiSelect` boolean: Gets or sets a value indicating whether multiple selections are allowed for this question. - `ChecklistFailure` boolean: Gets or sets a value indicating whether this question contributes to a checklist failure. - `AssetTypeIds` integer[]: Gets or sets the list of asset type IDs to which the question is applicable. - `CheckListQuestionNumericType` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistSettingsResponsesCheckListQuestionNumericTypeResponse: Represents an answer option configured for a checklist question of the Numeric type. - `Id` integer: Gets or sets the unique identifier of the answer option for a checklist question of the Numeric type. - `Type` 'LessThan' | 'MoreThan' | 'InBetween': Gets or sets the type value which represents the configuration for numeric options. - `SingleValue` integer: Gets or sets the single numeric value for the checklist question, if applicable. - `MinValue` integer: Gets or sets the minimum numeric value for the checklist question, if a range is applicable. - `MaxValue` integer: Gets or sets the maximum numeric value for the checklist question, if a range is applicable. - `DisplayForEachAsset` boolean: Gets or sets a value indicating whether the checklist allows each question to be answered multiple times for each asset on the work order. - `HasTransferedCheckList` boolean: Gets or sets a value indicating whether there is a transferred checklist. ## Other responses - `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
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.
Error codes: 504 — API call rejected by security permissions - `403`: The request is not allowed.
Error codes: 100 — User does not have access to work order - `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)