Skip to main content
GET
/
api
/
v1
/
files
/
{id}
Get a file
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/files/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "file",
    "attributes": {
      "created_at": "<string>",
      "updated_at": "<string>",
      "name": "annual_report.pdf",
      "content_type": "application/pdf",
      "byte_size": 1024000,
      "checksum_md5": "<string>",
      "url": "<string>",
      "locked": true,
      "state": "<string>"
    },
    "relationships": {
      "folder": {
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "created_by": {
        "links": {
          "related": "<string>"
        },
        "meta": {}
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.scholarlysoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Comma-separated list of relationships to include. Allowed: folder, created_by

Response

file found

​
data
object
required