Log In

Show a Document

get/public/v1/documents/{document}

Read a Document back by id, including the Document Categories assigned to it. archived_at is set while the Document is archived and null once it is restored. Whether a Document is visible depends on the record it is attached to, under the same rules as the download endpoint, so a Document you cannot download you cannot read here.

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

  • documentstringrequired

    The document UUID

Response

200application/json

DocumentResource

  • dataobjectrequired
    ▶Show 6 child attributes
    • idstringrequired
      Example:d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e
    • namestringrequired
      Example:Service Agreement
    • file_extensionstringrequired
      Example:pdf
    • archived_atstring | nullrequired
      Example:2024-02-01T09:00:00+00:00
    • created_atstringrequired
      Example:2024-01-15T10:30:00+00:00
    • categoriesobject[]required
      ▶Show 2 child attributes
      • idstringrequired
        Example:c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9
      • namestringrequired
        Example:Assessments
  • 401Unauthenticated
  • 403Authorization error
  • 404Not found