File API
Retrieve a specific file by its unique identifier
Support
File API
Retrieve detailed information about a specific file using its unique identifier. Access file metadata and download URL.
Single File
Specific file lookup.
Download URL
Direct access.
Metadata
Title and description.
Endpoint Overview
QUERY
/graphqlRetrieve a specific file by its unique ID.
Authentication:Bearer Token
Required scopes:useradmin
Request Parameters
idInt!RequiredThe unique identifier of the file to retrieve.
GraphQL Query
query file($id: Int!) {
file(id: $id) {
id
title
description
url
}
}Variables:
{
"id": 1
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query file($id: Int!) { file(id: $id) { id title description url } }",
"variables": { "id": 1 }
}'Response
200File Retrieved Successfully
{
"data": {
"file": {
"id": 1,
"title": "User Guide",
"description": "Comprehensive guide for users.",
"url": "https://example.com/files/user-guide.pdf"
}
}
}404File Not Found
{
"errors": [
{
"message": "File not found",
"path": ["file"],
"extensions": {
"code": "NOT_FOUND"
}
}
],
"data": null
}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.
Related Endpoints
View All Files
Retrieve the complete list of available files.