Get file metadata

GET

/api/nova/files/{fileId}

Returns the stored document identified by the fileId path parameter without downloading its contents: name, extension, content type, size, category, expiry, client portal visibility, who uploaded it and when, plus the record it is attached to. Returns 404 when the file does not exist in the account, 401 for an invalid API key and 429 when rate limited.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

fileId*

fileId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"data": {

  

  

"categoryId": "string",

  

  

"categoryName": "string",

  

  

"contentType": "string",

  

  

"expiresOn": "string",

  

  

"extension": "string",

  

  

"id": "string",

  

  

"name": "string",

  

  

"recordId": "string",

  

  

"recordLabel": "string",

  

  

"recordType": "string",

  

  

"showInClientPortal": true,

  

  

"size": 0,

  

  

"uploadedBy": "string",

  

  

"uploadedOn": "string"

  

},

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

GET

/api/nova/files/{fileId}

Playground

Authorization

privateApiKey

Variables

Key

Value

fileId*

apiKey*

Samples