List files on a record

GET

/api/nova/files/record/{recordId}

Returns the documents attached to the record given by the recordId path parameter, newest first - the same list the record's Files tab shows. Works for any record type. Accepts page and size query parameters (size defaults to 20 and is capped at 100). Each entry contains the file id, name, extension, content type, size, category, who uploaded it and when. Returns 404 when the record does not exist, 401 for an invalid API key and 429 when rate limited.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

recordId*

recordId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

page

page

Type

integer

Format

"int32"

Default

0

size

size

Type

integer

Format

"int32"

Default

20

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",

  

"page": 0,

  

"requestId": "string",

  

"size": 0,

  

"success": true,

  

"total": 0

}

GET

/api/nova/files/record/{recordId}

Playground

Authorization

privateApiKey

Variables

Key

Value

recordId*

apiKey*

page

size

Samples