---
title: "Find documents"
method: GET
path: "/documents"
tags: ["document"]
---

# Find documents

`GET /documents`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/documents`
- Auth: HTTP bearer

Use this to find a document, or the link made for someone ("the link I sent to Bo"). Documents, newest first, with their link and view counts; query matches a title, or a person a link was made for or who read one.

## Query parameters

- `query` string: Words from a title, or a person a link was made for or who read one: "deck", "jane".
- `sha256` string: A file's SHA-256, to find it before uploading it again.
- `limit` integer: How many, newest first; 50 when left out.
- `cursor` string: The next_cursor of the last call, for the page after it.

## Response `200`

The result.

- object
  - `items` object[], required
    - `id` string, required
    - `title` string, required
    - `version` integer, required
    - `pages` integer, required
    - `page_sizes` object[], required
      - `width` number, required
      - `height` number, required
    - `file_name` string, required
    - `sha256` string, required
    - `links` integer, required
    - `views` integer, required
    - `last_viewed_at` string, date-time, nullable, required
    - `envelopes` integer, required
    - `templates` object[], required
      - `id` string, required
      - `name` string, required
      - `roles` string[], required
    - `created_at` string, date-time, required
  - `next_cursor` string, nullable, required
  - `links_found` object[], required
    - `link_id` string, required
    - `document_id` string, nullable, required
    - `room_id` string, nullable, required
    - `label` string, nullable, required
    - `state` string, required

## Other responses

- `default`: An RFC 9457 problem.

---

[API](https://skmtc.dev/binderwork/apis/binderwork-api.md) · [All operations](https://skmtc.dev/binderwork/apis/binderwork-api/llms.txt) · [OpenAPI document](https://skmtc.dev/binderwork/apis/binderwork-api/revisions/f8fab0ebee53?raw)