Folio API

Resources

• Records

  File documents, read them back, and keep them warm when you need them often.

  • GET/folio/records
  • POST/folio/records
  • GET/folio/records/{id}
  • GET/folio/records/{id}/content
  • POST/folio/records/{id}/retention
  • POST/folio/records/{id}/early-delete
  • POST/folio/records/{id}/move
  • POST/folio/filings
  • GET/folio/filings/{id}
  • GET/folio/uploads
  • POST/folio/uploads
  • GET/folio/uploads/{id}
  • DELETE/folio/uploads/{id}
  • POST/folio/uploads/{id}/parts
  • POST/folio/uploads/{id}/complete
  • POST/folio/records/from-check
  • GET/folio/records/{id}/custody
  • GET/folio/records/{id}/integrity
  • POST/folio/records/{id}/link
  • GET/folio/records/{id}/restore
  • POST/folio/records/{id}/restore
  • GET/folio/restores
  • GET/folio/pins
  • POST/folio/pins
  • POST/folio/pins/{id}/end

• Folders

  Folders in the shape your team already works in.

  • POST/folio/folders/protect
  • POST/folio/folders/unprotect
  • POST/folio/folders/rename
  • GET/folio/folders
  • POST/folio/folders
  • GET/folio/folders/detail

• Imports

  Bring in whole collections at once, from an upload or your own storage tools.

  • GET/folio/imports
  • POST/folio/imports
  • GET/folio/imports/{id}
  • POST/folio/imports/{id}/content
  • GET/folio/imports/{id}/items
  • POST/folio/imports/{id}/close
  • GET/folio/imports/{id}/report
  • GET/folio/imports/{id}/manifest.csv
  • GET/folio/s3/keys
  • POST/folio/s3/keys
  • DELETE/folio/s3/keys/{id}
  • POST/folio/s3/sessions

• Retention and storage

  How long each record is kept, where it lives, and erasure requests.

  • GET/folio/classes
  • POST/folio/classes
  • GET/folio/classes/{id}/extension
  • POST/folio/classes/{id}/extend
  • GET/folio/erasure
  • POST/folio/erasure
  • GET/folio/profiles
  • GET/folio/residency

• Holds, reasons and approvals

  Legal holds, the reasons people give for opening records, and two-person approvals.

  • POST/folio/reasons
  • DELETE/folio/reasons/{id}
  • GET/folio/holds
  • POST/folio/holds
  • POST/folio/holds/{id}/release
  • POST/folio/approvals/{id}/approve
  • POST/folio/approvals/{id}/refuse
  • GET/folio/grants
  • POST/folio/grants
  • GET/folio/approvals

• Search

  Find records by name, matter or the words inside.

  • GET/folio/search

• Exports and links

  Take records out with their receipts, or share one through a link.

  • POST/folio/exports
  • GET/folio/exports/{id}
  • GET/folio/exports/{id}/download
  • GET/folio/links/{token}

• Ledger and usage

  Every read, change and refusal, and what this month has used.

  • GET/folio/ledger
  • GET/folio/usage
  • GET/folio/usage.csv
  • GET/folio/head-key

• Webhook endpoints

  Hear when something happens to your records.

  • GET/folio/webhooks
  • POST/folio/webhooks
  • DELETE/folio/webhooks/{webhook_id}

All 71 Folio schemas

Webhook events

• folio.export.ready
• folio.hold.applied
• folio.hold.released
• folio.integrity.alert
• folio.record.disposed
• folio.record.filed
• folio.restore.ready