Documents

List documents

Retrieves a paginated list of documents belonging to the

GET https://api.handwritingocr.com/v3/documents Try It

List documents

cURL

curl --request GET \
  --url 'https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer your-api-token'

import requests

url = "https://api.handwritingocr.com/v3/documents"

querystring = {"per_page":"SOME_INTEGER_VALUE","page":"SOME_INTEGER_VALUE","status":"SOME_STRING_VALUE","action":"SOME_STRING_VALUE","updated_since":"SOME_STRING_VALUE"}

headers = {"Authorization": "Bearer your-api-token"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer your-api-token'}};

fetch('https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer your-api-token'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer your-api-token"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer your-api-token")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

200 application/json

{
  "documents": [
    {
      "id": "k2D9ZRz9Ob",
      "file_name": "My-Document.pdf",
      "action": "transcribe",
      "page_count": 24,
      "status": "processed",
      "automatically_deleted_at": "2026-03-12T14:49:19.000000Z",
      "created_at": "2026-03-05T14:49:19.000000Z",
      "updated_at": "2026-03-05T14:49:19.000000Z"
    },
    {
      "id": "ql78YGv4dE",
      "file_name": "Test_Doc_2.pdf",
      "action": "transcribe",
      "page_count": 36,
      "status": "processed",
      "automatically_deleted_at": "2026-02-24T14:09:00.000000Z",
      "created_at": "2026-02-18T18:37:03.000000Z",
      "updated_at": "2026-02-20T00:50:30.000000Z"
    }
  ],
  "current_page": 1,
  "from": 1,
  "to": 2,
  "total": 63,
  "per_page": 2,
  "last_page": 63,
  "next_page_url": "https://api.handwritingocr.com/v3/documents?page=2",
  "prev_page_url": null
}

Retrieves a paginated list of documents belonging to the authenticated user. Documents are sorted by creation date in descending order.

Headers

Authorization string required header

Bearer your-api-token
Accept string required header

application/json

Query parameters

per_page integer query

Number of items per page. Default 50, maximum 200.
page integer query

The page number for pagination. Defaults to 1.
status string query

Only return documents whose processing has reached this status. Combine with action to filter on a specific action's status; without action, a document matches if any of its transcribe, tables, or extractor steps is at this status.

Allowed values: new queued processing processed failed
action string query

Only return documents submitted with this action.

Allowed values: transcribe tables extractor
updated_since string query

Only return documents updated strictly after this ISO 8601 timestamp (e.g. 2026-03-05T14:49:19Z), most recently updated first. Intended as a polling cursor: feed the first item's updated_at back on the next request. Note this changes the sort from creation date to update date, so documents that finish processing out of order are not missed.

Response codes

HTTP status

200

Returns a paginated list of documents.
401

Unauthorized — invalid or missing API token.
422

Validation Error — invalid parameters.

List documents

cURL

curl --request GET \
  --url 'https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer your-api-token'

import requests

url = "https://api.handwritingocr.com/v3/documents"

querystring = {"per_page":"SOME_INTEGER_VALUE","page":"SOME_INTEGER_VALUE","status":"SOME_STRING_VALUE","action":"SOME_STRING_VALUE","updated_since":"SOME_STRING_VALUE"}

headers = {"Authorization": "Bearer your-api-token"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer your-api-token'}};

fetch('https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer your-api-token'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer your-api-token"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.handwritingocr.com/v3/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&action=SOME_STRING_VALUE&updated_since=SOME_STRING_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer your-api-token")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

200 application/json

{
  "documents": [
    {
      "id": "k2D9ZRz9Ob",
      "file_name": "My-Document.pdf",
      "action": "transcribe",
      "page_count": 24,
      "status": "processed",
      "automatically_deleted_at": "2026-03-12T14:49:19.000000Z",
      "created_at": "2026-03-05T14:49:19.000000Z",
      "updated_at": "2026-03-05T14:49:19.000000Z"
    },
    {
      "id": "ql78YGv4dE",
      "file_name": "Test_Doc_2.pdf",
      "action": "transcribe",
      "page_count": 36,
      "status": "processed",
      "automatically_deleted_at": "2026-02-24T14:09:00.000000Z",
      "created_at": "2026-02-18T18:37:03.000000Z",
      "updated_at": "2026-02-20T00:50:30.000000Z"
    }
  ],
  "current_page": 1,
  "from": 1,
  "to": 2,
  "total": 63,
  "per_page": 2,
  "last_page": 63,
  "next_page_url": "https://api.handwritingocr.com/v3/documents?page=2",
  "prev_page_url": null
}