Retrieve a profile checklist
1 min
GET
https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}
Path Parameters
- uuidstringrequiredDescription
- idstringrequiredDescription
Responses
200
- object
- dataChecklistResource
- idnumberrequiredDescription
- namestringrequiredDescription
- sectionsobject[]Description
- idnumberDescription
- namestringDescription
- tasksobject[]Description
- idnumberDescription
- namestringDescription
- teamobjectDescription
- idnumberDescription
- namestringDescription
- members_countnumberDescription
- statusstring<exempt | failed | passed | needs_review>DescriptionAllowedexemptfailedpassedneeds_review
- total_commentsnumberDescription
- member_belongs_to_teambooleanDescription
- uncompleted_tasksnumberDescription
- completed_tasksnumberDescription
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
- x-ratelimit-reset
- retry-after
401
- object
- messagestringDescription
404
- object
- messagestringDescription
429
- object
- messagestringDescription
curl
curl --request GET \
--url https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/profiles/{uuid}/checklists/{id}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"data": {
"id": 0,
"name": "",
"sections": [
{
"id": 0,
"name": "",
"tasks": [
{
"id": 0,
"name": "",
"team": {
"id": 0,
"name": "",
"members_count": 0
}
}
],
"status": "",
"total_comments": 0,
"member_belongs_to_team": false
}
],
"uncompleted_tasks": 0,
"completed_tasks": 0
}
}401
// Unauthorized. The access token is missing, invalid or has expired.
{
"message": ""
}404
// Not Found. The requested resource does not exist, or is not available to your account.
{
"message": ""
}429
// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.
{
"message": ""
}