Skip to main content
GET
/
v1
/
ai-variables
/
folders
/
companies
List company AI variable folders
curl --request GET \
  --url https://openapi.enginy.ai/v1/ai-variables/folders/companies \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "parentId": 123,
      "entity": "CONTACT",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "aiVariablesCount": 123,
      "subfoldersCount": 123,
      "totalSubfoldersCount": 123,
      "totalAiVariablesCount": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
includeChildren
enum<string>

When true, includes nested folders instead of returning only root folders.

Available options:
true,
false
​
includeRecursiveCounts
enum<string>

When true, includes recursive subfolder and AI variable counts.

Available options:
true,
false

Response

200 - application/json

Folders retrieved successfully

​
status
enum<string>
required
Available options:
success
​
message
string
required
​
data
object[]
required