Files API

Retrieve all available files and documents

Support

Files API

Retrieve a complete list of all available files and documents. Access user guides, documentation, and downloadable resources.

All Files

Complete file list.

Download URLs

Direct access links.

Descriptions

File metadata.


Endpoint Overview

QUERY/graphql

Retrieve all files with their titles, descriptions, and download URLs.

Authentication:Bearer Token
Required scopes:useradmin

GraphQL Query

query files {
  files {
    id
    title
    description
    url
  }
}

Variables:

{}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query files { files { id title description url } }",
    "variables": {}
  }'

Response

200Files Retrieved Successfully
{
  "data": {
    "files": [
      {
        "id": 1,
        "title": "User Guide",
        "description": "Comprehensive guide for users.",
        "url": "https://example.com/files/user-guide.pdf"
      },
      {
        "id": 2,
        "title": "API Documentation",
        "description": "Detailed API documentation.",
        "url": "https://example.com/files/api-docs.pdf"
      }
    ]
  }
}

Response Fields

idInt!

Unique identifier for the file.

titleString!

Title or name of the file.

descriptionString!

Description of the file contents.

urlString!

URL to access or download the file.



Get Specific File

Retrieve details of a specific file by its ID.

File by ID