Retrieve documents

GET

https://api.detected.app/api/v2/public/documents

Introduction

This endpoint returns a list of documents

idnumberThe <code>id</code> parameter filters by an internal <code>id</code>. If a match is found, the response will return a single result.

order_bystringOrder results in ascending (<code>asc</code>) or descending (<code>desc</code>) order. This parameter only works when <code>sort_by</code> is specified.

sort_bystringThe <code>sort_by</code> parameter allows you to specify most fields to sort the results in either ascending (<code>asc</code>) or descending (<code>desc</code>) order. This parameter works in conjunction with <code>order_by</code>. If <code>order_by</code> is not specified, the default sorting order is ascending (<code>asc</code>). Currently, we support these fields: <ol> <li><code>created_at</code></li> <li><code>updated_at</code></li> <li><code>id</code></li> <li><code>profile_id</code></li> <li><code>document_id</code></li> <li><code>category</code></li> <li><code>name</code></li> </ol>

pagestringCurrent page number

profile_idstringThe <code>profile_id</code> parameter allows to filter documents by their profile

document_idstringThe <code>document_id</code> parameter allows to filter documents by their document_id

categorystringThe <code>category</code> parameter allows to filter documents by their category

namestringThe <code>name</code> parameter allows to filter documents by their name

acceptstringGenerated from available response content types

AuthorizationstringBearer token

200Ok

401Unauthorized

429Too Many Requests

curl --request GET \
     --url https://api.detected.app/api/v2/public/documents \
     --header 'accept: application/json'