---
title: Retrieve a profile checklist
slug: andrei/retrieve-a-profile-checklist
createdAt: 2026-10-05T10:36:01.732Z
---

{
  "id": "UEH9Casl5nLwIEql7yzeI",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}",
    "servers": [
      {
        "url": "https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}",
        "description": "Production"
      }
    ],
    "name": "Retrieve a profile checklist",
    "description": "<p>Returns a single checklist for a profile, including its sections, tasks and progress.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "uuid",
          "type": "string",
          "description": "<p>UUID of the item named in the path, for example the profile in <code>/profiles/{uuid}</code> or the representative in <code>/representatives/{uuid}</code>.</p>"
        },
        {
          "kind": "required",
          "name": "id",
          "type": "string",
          "description": "<p>ID of the item named in the path, for example the form in <code>/forms/{id}</code> or the document in <code>/documents/{id}</code>.</p>"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "AccessToken",
          "name": "AccessToken",
          "kind": "optional",
          "type": "http",
          "description": "<p>The API uses OAuth 2.0. Request an access token from <code>POST /oauth/token</code> with the client ID and client secret of your integration client, and your account slug. Send the access token in the <code>Authorization</code> header of every request, in the format <code>Authorization: Bearer &#x3C;access_token></code>. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "headers": [
          {
            "kind": "optional",
            "name": "X-RateLimit-Limit",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "X-RateLimit-Remaining",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "x-ratelimit-reset",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "retry-after",
            "description": ""
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "data",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/ChecklistResource",
                "customType": "ChecklistResource",
                "schema": [
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "number",
                    "description": "Checklist ID."
                  },
                  {
                    "name": "name",
                    "kind": "required",
                    "type": "string",
                    "description": "Name of the checklist."
                  },
                  {
                    "name": "sections",
                    "kind": "optional",
                    "type": "array",
                    "description": "Sections of the checklist.",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "number",
                        "description": "Section ID."
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "string",
                        "description": "Name of the section."
                      },
                      {
                        "name": "tasks",
                        "kind": "optional",
                        "type": "array",
                        "description": "Tasks in the section.",
                        "example": "",
                        "itemType": "object",
                        "customType": "object[]",
                        "schema": [
                          {
                            "name": "id",
                            "kind": "optional",
                            "type": "number",
                            "description": "Task ID."
                          },
                          {
                            "name": "name",
                            "kind": "optional",
                            "type": "string",
                            "description": "Name of the task."
                          },
                          {
                            "name": "team",
                            "kind": "optional",
                            "type": "object",
                            "description": "Team the task is assigned to.",
                            "example": "",
                            "schema": [
                              {
                                "name": "id",
                                "kind": "optional",
                                "type": "number",
                                "description": "Team ID."
                              },
                              {
                                "name": "name",
                                "kind": "optional",
                                "type": "string",
                                "description": "Name of the team."
                              },
                              {
                                "name": "members_count",
                                "kind": "optional",
                                "type": "number",
                                "description": "Number of members in the team."
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "name": "status",
                        "kind": "optional",
                        "type": "string<exempt | failed | passed | needs_review>",
                        "description": "<p>Status of the section: <code>exempt</code>, <code>failed</code>, <code>passed</code> or <code>needs_review</code>.</p>",
                        "enum": [
                          "exempt",
                          "failed",
                          "passed",
                          "needs_review"
                        ]
                      },
                      {
                        "name": "total_comments",
                        "kind": "optional",
                        "type": "number",
                        "description": "Total number of comments on the section."
                      },
                      {
                        "name": "member_belongs_to_team",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Whether the authenticated user is a member of the team the task is assigned to."
                      }
                    ]
                  },
                  {
                    "name": "uncompleted_tasks",
                    "kind": "optional",
                    "type": "number",
                    "description": "<p>Number of tasks that have not yet been marked <code>Passed</code>, <code>Needs review</code> or <code>Failed</code>.</p>"
                  },
                  {
                    "name": "completed_tasks",
                    "kind": "optional",
                    "type": "number",
                    "description": "<p>Number of tasks that have been marked <code>Passed</code>, <code>Needs review</code> or <code>Failed</code>, across all sections.</p>"
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The access token is missing, invalid or has expired.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "<p>Not Found. The requested resource does not exist, or is not available to your account.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "429",
        "description": "<p>Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK\n{\n  \"data\": {\n    \"id\": 0,\n    \"name\": \"\",\n    \"sections\": [\n      {\n        \"id\": 0,\n        \"name\": \"\",\n        \"tasks\": [\n          {\n            \"id\": 0,\n            \"name\": \"\",\n            \"team\": {\n              \"id\": 0,\n              \"name\": \"\",\n              \"members_count\": 0\n            }\n          }\n        ],\n        \"status\": \"\",\n        \"total_comments\": 0,\n        \"member_belongs_to_team\": false\n      }\n    ],\n    \"uncompleted_tasks\": 0,\n    \"completed_tasks\": 0\n  }\n}"
        },
        {
          "id": "response-1-401",
          "language": "401",
          "code": "// Unauthorized. The access token is missing, invalid or has expired.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-404",
          "language": "404",
          "code": "// Not Found. The requested resource does not exist, or is not available to your account.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-3-429",
          "language": "429",
          "code": "// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}