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"
fetch("https://api.scan-documents.com/v1/files?take=20&from=string")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.scan-documents.com/v1/files?take=20&from=string"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.scan-documents.com/v1/files?take=20&from=string"

response = requests.request("GET", url)

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://api.scan-documents.com/v1/files?take=20&from=string"))
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
var response = await client.GetAsync("https://api.scan-documents.com/v1/files?take=20&from=string");
var responseBody = await response.Content.ReadAsStringAsync();
{
  "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."
}