Files

Get files paginated

Gets the files of the user paginated

GET
/v1/files
x-api-key
<token>

API Key for authentication

In: header

Query Parameters

take
number

The number of elements to retrieve

Default20
Range1 <= value <= 100
from
string

The id of the file from which to start the search

Response Body

curl -X GET "https://api.scan-documents.com/v1/files?take=20&from=string"
{
  "data": [
    {
      "id": "file_euyrvozb9302uwhq",
      "name": "Example Image",
      "type": "image/png",
      "properties": {
        "size": 1024,
        "width": 800,
        "height": 600
      },
      "task_id": null,
      "created_at": "2021-05-01T12:00:00Z"
    }
  ],
  "links": {
    "previous": "https://api.scan-documents.com/files?from=file_euyrvozb9302uwhq&take=1",
    "next": "https://api.scan-documents.com/files?from=file_euyrvozb9302uwhq&take=1"
  }
}
{
  "type": "https://scan-documents.com/docs/errors/validation-error",
  "title": "Validation Error",
  "status": 422,
  "errors": {
    "{field}": [
      "{error}."
    ]
  }
}
{
  "type": "https://scan-documents.com/docs/errors/rate-limit-error",
  "title": "Rate Limit Exceeded",
  "status": 429,
  "message": "Rate limit exceeded. Please try again later or contact support."
}
{
  "type": "https://scan-documents.com/docs/errors/internal-error",
  "title": "An unexpected error occurred. Contact support if the problem persists.",
  "status": 500,
  "message": "An unexpected error occurred. Contact support if the problem persists."
}