# How folio works

> You file a record and get a receipt for it, and Folio keeps it for as long as its class says.

Source: https://unforged.ai/folio/docs

## Start

- [Quickstart: file your first record](https://unforged.ai/folio/docs/quickstart.md): File your first record from your own code, then find it again.
- [The ideas behind Folio](https://unforged.ai/folio/docs/concepts.md): Records, folders, retention classes, reasons, holds and the ledger, and how they fit together.

## Keep

- [Filing records and organising folders](https://unforged.ai/folio/docs/filing-and-folders.md): Filing one document or a whole import, and folders in the shape your team already works in.
- [How long each record is kept](https://unforged.ai/folio/docs/retention-classes.md): How long each record is kept, Retained or Locked, and what happens at the end.
- [How holds and approvals work](https://unforged.ai/folio/docs/holds-and-approvals.md): Holding records through a dispute, and the changes that need a second person.

## Find

- [Finding records](https://unforged.ai/folio/docs/search.md): Finding records by name, matter or the words inside, and what a search can't promise.

## Share

- [Exports, reports and links](https://unforged.ai/folio/docs/exports-and-links.md): Taking records out with their receipts, reports for your auditor, and a link for one record.

## Reference

- [Webhooks](https://unforged.ai/folio/docs/webhooks.md): The events Folio sends to your systems, and how to check each one came from us.

## The API

The same routes serve the web app and your own code. Each needs an API key with the right permission, and changes and deletions need a reason, as do views if your organisation asks for one.

### Filing

- `POST /folio/records`
- `POST /folio/filings`
- `GET /folio/filings/{id}`
- `POST /folio/records/from-check`

### Records

- `GET /folio/records`
- `GET /folio/records/{id}`
- `GET /folio/records/{id}/content`
- `POST /folio/records/{id}/move`
- `POST /folio/records/{id}/retention`

### Folders

- `GET /folio/folders`
- `POST /folio/folders`
- `GET /folio/folders/detail`
- `POST /folio/folders/protect`

### Reasons

- `POST /folio/reasons`
- `DELETE /folio/reasons/{id}`

### Holds and approvals

- `POST /folio/holds`
- `GET /folio/holds`
- `POST /folio/holds/{id}/release`
- `GET /folio/approvals`
- `POST /folio/approvals/{id}/approve`

### Exports and reports

- `POST /folio/exports`
- `GET /folio/exports/{id}`
- `GET /folio/exports/{id}/download`
- `GET /folio/records/{id}/custody`
- `GET /folio/records/{id}/integrity`
- `GET /folio/residency`

### Links

- `POST /folio/records/{id}/link`
- `GET /folio/links/{token}`

### Classes and settings

- `GET /folio/classes`
- `POST /folio/classes`
- `GET /folio/config`
- `PATCH /folio/config`

### Search

- `GET /folio/search`

### Ledger, usage and webhooks

- `GET /folio/ledger`
- `GET /folio/usage`
- `GET /folio/webhooks`
- `POST /folio/webhooks`

The full reference is with the rest of our API docs. [Open the reference](https://unforged.ai/docs/folio), or download [folio.yaml](https://unforged.ai/api/folio.yaml).

Folio is designed to support your record-keeping obligations under UK GDPR and GDPR, and the long-term keeping of electronically signed documents.
