---
title: "Get a response to a checklist question"
method: POST
path: "/checklists/ChecklistResponse/get"
tags: ["CheckLists"]
---

# Get a response to a checklist question

`POST /checklists/ChecklistResponse/get`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/checklists/ChecklistResponse/get`
- 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/ChecklistResponse/get/post.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `workOrderId` integer, required

## Request body

- integer[]

## Response `200`

The specified responses to a checklist questions are returned.

- ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistResponseWithPictures[]
  - `ChecklistResponse` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistResponse: Checklist response object.
    - `Id` integer: Checklist response ID.
    - `Answer` string: Answer to a checklist question.
    - `FreeTextAnswer` string: Comment to an answer option with the `IsConditionalFollowUp` attribute. Answer options are configured for questions of the **Selector** type.
    - `EntityId` integer: ID of the work order the response was submitted for.
    - `EntityTypeId` integer: ID of the entity the response was submitted for. 0 is returned for work orders.
    - `Attempt` integer: Order of a technician’s on-site visit when the response was submitted.
    - `ProviderId` integer: ID of the provider on whose behalf the response was submitted.
    - `TechnicianId` integer: ID of the technician on whose behalf the response was submitted.
    - `UpdatedDate` string, date-time: Date and time when the response was last updated set in EST. The format is `YYYY-MM-DDThh:mm:ss.sss`.
    - `UpdatedDateStr` string: Date and time when the response was last updated set in the location’s time zone. The format is `Month Day Year hh:mm`.
    - `UpdatedDateDto` string, date-time: Date and time when the response was last updated set in the location’s time zone with the UTC offset. The format is `YYYY-MM-DDThh:mm:ss.sss±hh:mm`.
    - `CheckListQuestionId` integer: ID of the checklist question the response was submitted for.
    - `QuestionOptions` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistQuestionOptionResponse[]: List of the answer options configured for a checklist question of the **Selector** type where multiple options can be selected.
      - `Id` integer: ID of the answer option for a checklist question of the **Selector** type.
      - `Answer` string: 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: Not applicable to checklists.
      - `IsConditionalFollowUp` boolean: Defines 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: Option for a checklist question of the **Selector** type.
    - `CheckListQuestionOptionId` integer: ID of the answer option configured for a checklist question of the **Selector** type.
    - `AssetId` integer: ID of the asset for which the response was submitted.
    - `IsPassed` boolean: Indicates whether the response avoids the failure criteria.
    - `LinkedWorkOrderId` integer: ID of the linked work order if the response results in a failure and generates a linked work order. Null if the response does not result in a failure or if the failure does not generate a linked work order.
  - `ChecklistResponsePictures` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistPictureResponse[]: Files attached to a checklist response.
    - `Id` integer: ID of the file attached to the checklist response.
    - `CheckListResponseId` integer: ID of the checklist response the attachment is submitted for.
    - `DocumentName` string: Attachment name.
    - `DocumentPath` string: Attachment path.
    - `ThumbnailPath` string: Attachment thumbnail path.
    - `HasThumbnail` boolean: Defines whether a thumbnail is available for the attachment.
    - `UpdatedBy` integer: User Id.

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 503 - Bad request
- `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)