---
title: "Get Checklist Details"
method: GET
path: "/settings/checklist/{checklist_uid}"
---

# Get Checklist Details

`GET /settings/checklist/{checklist_uid}`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/settings/checklist/{checklist_uid}`
- Auth: API key in header `x-api-key`

## Path parameters

- `checklist_uid` string, required

## Response `200`

200

- object
  - `type` string
  - `data` object
    - `checklist_uid` string
    - `job_category` object
      - `category_uid` string
      - `category_name` string
      - `category_color` string
    - `job_status` object
      - `job_statuses` object
        - `status_uid` string
        - `status_name` string
        - `status_type` string
        - `status_color` string
        - `require_customer_signature` boolean
        - `require_preview` boolean
        - `require_customer_feedback` boolean
        - `require_facial_authentication` boolean
        - `require_geo_fencing` boolean
        - `parent_status` unknown[]
          - unknown
        - `enabled_for_field_executive` boolean
        - `enabled_for_manager` boolean
        - `allow_remarks` boolean
        - `capture_geo_cords` boolean
        - `has_parent` boolean
        - `remarks_values` unknown[]
          - unknown
        - `restrict_to_access_role` boolean
        - `enabled_to_access_role` unknown[]
          - unknown
    - `field_name` string
    - `checklist_view_type` string
    - `field_type` string
    - `field_description` string
    - `field_placeholder` string
    - `field_options` unknown[]
      - unknown
    - `display_order` integer
    - `field_validation` string
    - `min_value` integer
    - `max_value` integer
    - `is_required` boolean
    - `original_template` object
      - `id` integer
      - `component` string
      - `editable` boolean
      - `index` integer
      - `label` string
      - `description` string
      - `required` boolean
      - `validation` string
      - `hide_to_fe` boolean
      - `is_dependent` boolean
      - `dependent_on` unknown
      - `dependent_options` unknown[]
        - unknown
      - `prefill_checklist` boolean
      - `default_options` unknown[]
        - unknown
      - `hide_field` boolean
      - `read_only` boolean
      - `min_value` integer
      - `max_value` integer
      - `default_option` boolean
      - `group` string
      - `dependents` unknown[]
        - unknown
      - `restrict_status_update` unknown
      - `restrict_to_camera` boolean
      - `watermark_image` boolean
      - `watermark_timestamp` boolean
      - `watermark_geo_cords` boolean
      - `meta_options` object
        - `restrict_to_camera` boolean
        - `watermark_image` boolean
        - `watermark_timestamp` boolean
        - `watermark_geo_cords` boolean
        - `restrict_status_update` object
          - `is_enabled` boolean
          - `restricted_options` unknown[]
            - unknown
          - `message` unknown
      - `checklist_view_type` string
      - `field_type` string
    - `is_dependent` boolean
    - `dependent_on` unknown
    - `dependent_options` unknown[]
      - unknown
    - `prefill_checklist` boolean
    - `default_option` boolean
    - `default_options` unknown[]
      - unknown
    - `hide_field` boolean
    - `read_only` boolean
    - `meta_options` object
      - `restrict_to_camera` boolean
      - `watermark_timestamp` boolean
      - `watermark_geo_cords` boolean
      - `restrict_status_update` object
        - `is_enabled` boolean
        - `restricted_options` unknown[]
          - unknown
        - `message` unknown
    - `is_deleted` boolean

## Other responses

- `500`: 500

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/settings/checklist/:checklist_uid/get.md)

---

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