---
title: List of the documents
description: "Returns *flat list* of all documents that are stored in OKdokument for given API key. ## Service specification | URL | https://apidev.okdokument.com/JSON/list/flat | | --- | --- | | Method | GET | | Authentication | Header x-api-key | |…"
url: "https://wiki.signatus.com/documentation/okdokument-api/3-1-list-of-the-documents/"
updated: "2026-05-08"
category: 3. Additional API services
---

# List of the documents

Returns *flat list* of all documents that are stored in OKdokument for given API key.

## Service specification

| URL | https://apidev.okdokument.com/JSON/list/flat |
| --- | --- |
| Method | GET |
| Authentication | Header x-api-key |
| Response Type | application/json |

## Request description

Request parameters:

| Key | Type | Description |
| --- | --- | --- |
| state | query | Code of the state of documents to list or * for lists all states |

 HTTP- Click to view HTTP code snippet

```
GET /JSON/list/flat HTTP/1.1
Host: localhost:8080
x-api-key: 7796b696_bd2b1aaf7ef4f09be9f52ce2d8d599674d81aa9d6a4421696dc4d93dd0619d682ce56b4d64a9ef097761ced99e0f67265b5f76085e5b0ee7ca4696b2ad6fe2b2
```

## Response description

| Status code | Description |
| --- | --- |
| 200 OK | Document list |
| 401 Unauthorized | When user is not authenticated |
| 403 Forbidden | When user lacks required permissions |
| 500 Internal Server Error | Server processing error |

The response body is a JSON array of objects where each object represents a document.

Properties of the array elements:

| filename | Name of the item. (*.pdf) |
| --- | --- |
| id | Unique identification of the document (used to send acknowledgments) |
| url | Link to download PDF document |
| state | State of the document: “tosign” or “signed” (set by an upload or acknowledgment operation) |

Example of a success response:

```
[
	{
		"filename": "462416f3-22ce-427b-8be9-b04e3b8665c7.pdf",
		"state": "tosign",
		"modification": "2022-06-01 14:11:40",
		"id": "y7Ki_u1mrUwijfb-o_S1JiphSsoXya8iypH380F",
		"url": "https://apidev.okdokument.com/rest/document/y7Ki_u1mrUwijfb-o_S1JiphSsoXya8iypH380F",
		"date": 1655085500971,
		"number": "1655085500880",
		"group": "api_user"
	}
]
```