Skip to main content
POST
/
organizations
/
folders
/
get
Get Folders
curl --request POST \
  --url https://api.velt.dev/v2/organizations/folders/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <api-key>' \
  --header 'x-velt-auth-token: <api-key>' \
  --data '{
  "data": {
    "organizationId": "<string>",
    "folderId": "<string>",
    "maxDepth": 123
  }
}'
{
  "result": {
    "status": "<string>",
    "message": "<string>",
    "data": [
      {
        "folderId": "yourFolderId",
        "folderName": "yourFolderName",
        "parentFolderId": "yourParentFolderId",
        "organizationId": "<string>",
        "createdAt": 123,
        "lastUpdated": 123,
        "subFolders": [
          {
            "folderId": "yourFolderId",
            "folderName": "yourFolderName",
            "parentFolderId": "yourParentFolderId",
            "organizationId": "<string>",
            "createdAt": 123,
            "lastUpdated": 123
          }
        ]
      }
    ]
  }
}

Authorizations

​
x-velt-api-key
string
header
required

Your API key from the Velt Console

​
x-velt-auth-token
string
header
required

Your Auth Token for authentication

Body

application/json
​
data
object
required

Response

Folders retrieved successfully

​
result
object