Get File

get File.

The Files module provides cloud storage and file management — upload, download, access control, metadata, and CDN-backed delivery. Files can be referenced from Database records and follow the same identity and permission rules as the rest of the project.

This endpoint returns a single file by id.

get

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters

FilesIntegrationIdstring · nullableRequired

The files integration id to read from, from get_files_integrations.

Pathstring · nullableRequired

The path of the file to fetch metadata for.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

isPublicboolean · nullableOptional

publicUrlstring · nullableOptional

get/{version}/files/item

HTTPcURLJavaScriptPython

GET /{version}/files/item?FilesIntegrationId=text&Path=text HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "file": {
    "integrationId": "text",
    "path": "text"
  },
  "isPublic": true,
  "publicUrl": "text"
}

In the dashboard

Manage this visually in Norbix Cloud — see Files.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get File in the SDK reference, with examples in every language.