Skip to main content
GET
/
v3
/
documents
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/documents \
  --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>"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<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.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
all_content,
folder,
latest_content,
organisation
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
name,
-name,
content_type,
-content_type,
size,
-size,
downloads,
-downloads,
created_at,
-created_at
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • organisation_in: Filter documents where the organisation ID is in the provided list.
  • parent: Filter documents where the parent folder ID is in the provided list.
  • is_root: Filter documents where the parent folder ID is null.
  • mine: Filter documents where the current user is the author.

For more information on using named filters, see the docs

Response

Get a list of documents.

JSON API response object

data
object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a document is returned

Document content