Skip to content
Brooklyn Solutions Developers

Documents

Every uploaded document: its details, tags, expiry dates and extracted metadata.

Loading a list with search, filters and paging? Use Documents — list screen: the filters go in the request body.

Base path
/files

Endpoints

19 endpoints

Method

Standard Operations

7
  • GET /files List documents (with search, filters and paging).
  • POST /files Create a new document.
  • PATCH /files/bulk Update several documents at once.
  • GET /files/{id} Open a single document.
  • PUT /files/{id} Replace a document's details in full.
  • PATCH /files/{id} Edit a document.
  • DELETE /files/{id} Delete a document.

Additional Operations

12
  • DELETE /files/{entityId}/tags/{tagId} Remove a tag from a document.
  • GET /files/{id}/tags See the tags on a document.
  • POST /files/{id}/tags Add a tag to a document.
  • POST /files/defaultValues Get suggested values for a new document's details.
  • GET /files/{fileId}/content Download a document's contents.
  • GET /files/{fileId}/expiry-setting Show a document's expiry date reminder.
  • POST /files/{fileId}/expiry-setting Set an expiry date reminder on a document.
  • DELETE /files/{fileId}/expiry-setting Remove a document's expiry reminder.
  • POST /files/{fileId}/renew-expiration Renew a document's expiry date.
  • GET /files/documentMetadata/{fileId} Show details Brooklyn extracted from a document (parties, dates…).
  • POST /files/documentMetadata/retry/{fileId} Try extracting a document's details again.