List file categories

GET

/api/nova/files/categories

Returns the account's file categories as id and name pairs. Use an id here as the optional categoryId when uploading a file, so the document lands in the right category on the record's Files tab. The only required parameter is the apiKey; returns 401 if it is invalid and 429 when rate limited.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Query Parameters

apiKey*

apiKey

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string"

  

  

}

  

],

  

"error": "string",

  

"message": "string",

  

"page": 0,

  

"requestId": "string",

  

"size": 0,

  

"success": true,

  

"total": 0

}

GET

/api/nova/files/categories

Playground

Authorization

privateApiKey

Variables

Key

Value

apiKey*

Samples