Get Checklist Details

Changed on
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_uidstring required

Response

200

typestring

Example response

{
  "type": "success",
  "data": {
    "checklist_uid": "396dec16-88ad-467e-84de-a826c18a0a8a",
    "job_category": {
      "category_uid": "14e25638-12d9-4cbe-8f43-b16e868042e3",
      "category_name": "AC Installation",
      "category_color": "#000"
    },
    "job_status": {
      "job_statuses": {
        "status_uid": "ac015bfe-653c-4f4f-ada0-32d20c58319b",
        "status_name": "On My Way",
        "status_type": "ON_MY_WAY",
        "status_color": "#3498db",
        "enabled_for_field_executive": true,
        "enabled_for_manager": true
      }
    },
    "field_name": "test readme doc",
    "checklist_view_type": "SINGLE_PAGE",
    "field_type": "SINGLE_LINE",
    "field_description": "test readme doc",
    "display_order": 1,
    "field_validation": "number",
    "min_value": 1,
    "max_value": 2,
    "is_required": true,
    "original_template": {
      "id": 1,
      "component": "textInput",
      "editable": true,
      "index": 1,
      "label": "test readme doc",
      "description": "test readme doc",
      "required": true,
      "validation": "[number]",
      "min_value": 1,
      "max_value": 2,
      "group": "Default",
      "checklist_view_type": "SINGLE_PAGE",
      "field_type": "SINGLE_LINE"
    }
  }
}

Changes