Scan Documents

Authorization

x-api-key

<token>

API Key for authentication

In: header

Query Parameters

take

number

The number of elements to retrieve

Default: 20Minimum: 1Maximum: 100

from

string

The id of the file from which to start the search

Response Body

Successfully retrieved the list of files.

TypeScript Definitions

Use the response body type in TypeScript.

datarequired

array<File Response>

The list of files

linksrequired

object

curl -X GET "https://api.scan-documents.com/v1/files?take=20&from=string" \
  -H "x-api-key: <token>"

{
  "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"
  }
}

Authorization

Query Parameters

Response Body

File Response

Show Attributes