List documents
1 min
GET
https://api.detected.app/api/v2/public/documents
Query Parameters
- idnumberDescription
- order_bystringDescriptionAlloweddescasc
- sort_bystringDescription
- pagestringDescription
- profile_idstringDescription
- document_idstringDescription
- categorystringDescription
- namestringDescription
Responses
200
- object
- dataDocumentListResponse[]Description
- idnumberrequiredDescription
- profile_idstringrequiredDescription
- library_idstringrequiredDescription
- categorystringrequiredDescription
- namestringrequiredDescription
- updated_atstringrequiredDescription
- created_atstringrequiredDescription
- linksLinksResource
- firststringDescription
- laststringDescription
- prevstringDescription
- nextstringDescription
- metaMetaResource
- current_pagenumberDescription
- fromnumberDescription
- last_pagenumberDescription
- linksobject[]Description
- urlstringDescription
- labelstringDescription
- activebooleanDescription
- pathstringDescription
- per_pagenumberDescription
- tonumberDescription
- totalnumberDescription
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
- x-ratelimit-reset
- retry-after
401
- object
- messagestringDescription
429
- object
- messagestringDescription
curl
curl --request GET \
--url https://api.detected.app/api/v2/public/documents \
--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/documents", 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/documents")
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/documents"
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,
"profile_id": "",
"library_id": "",
"category": "",
"name": "",
"updated_at": "",
"created_at": ""
}
],
"links": {
"first": "",
"last": "",
"prev": "",
"next": ""
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [
{
"url": "",
"label": "",
"active": false
}
],
"path": "",
"per_page": 0,
"to": 0,
"total": 0
}
}401
// Unauthorized. The access token is missing, invalid or has expired.
{
"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": ""
}