Skip to main content
GET
/
v3
/
documents
/
{document_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/documents/{document_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "downloads": 123,
      "latest": {
        "content_type": "<string>",
        "checksum": "<string>",
        "size": 123
      },
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "all_content": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "author": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "folder": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "latest_content": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {},
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "extension": "<string>",
        "downloads": 123,
        "checksum": "<string>",
        "content_type": "<string>",
        "is_latest": true,
        "size": 123,
        "version": 123
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "author": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "document": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

document_id
string<uuid>
required

The unique identifier for the document.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
all_content,
folder,
latest_content,
organisation

Response

Get a document.

JSON API response object

data
object
required

A document

jsonapi
object
required
included
object[]

Related resources that can be included when a document is returned

Document content