Skip to main content
GET
/
api
/
partner
/
v1
/
folders
/
{folderId}
curl --request GET \
  --url https://www.genviral.io/api/partner/v1/folders/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "code": 200,
  "message": "Folder retrieved",
  "data": {
    "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Product Shots",
    "media_type": "upload",
    "parent_folder_id": null,
    "path": "/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "file_count": 12,
    "subfolder_count": 2,
    "preview_files": [
      {
        "id": "file_1",
        "url": "https://cdn.vireel.io/...",
        "content_type": "image/jpeg"
      }
    ],
    "created_at": "2026-03-01T09:00:00.000Z",
    "updated_at": "2026-03-01T09:00:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.genviral.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns a single folder summary, including counts and preview files.

​
Path Parameters

​
folderId
string
required
Folder UUID.
curl --request GET \
  --url https://www.genviral.io/api/partner/v1/folders/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "code": 200,
  "message": "Folder retrieved",
  "data": {
    "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Product Shots",
    "media_type": "upload",
    "parent_folder_id": null,
    "path": "/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "file_count": 12,
    "subfolder_count": 2,
    "preview_files": [
      {
        "id": "file_1",
        "url": "https://cdn.vireel.io/...",
        "content_type": "image/jpeg"
      }
    ],
    "created_at": "2026-03-01T09:00:00.000Z",
    "updated_at": "2026-03-01T09:00:00.000Z"
  }
}

​
Error Responses

  • 400 missing_folder_id - missing route parameter
  • 422 invalid_path - folderId is not a valid UUID
  • 422 invalid_folder_media_type - folder media type is not supported by Partner folder APIs
  • 404 not_found - folder not visible in key scope
  • 401 - authentication failed (missing/invalid/revoked token)
  • 402 subscription_required - active Creator/Professional/Business plan required
  • 403 tier_not_allowed - Scheduler tier cannot use Partner API
  • 500 folder_get_failed - unexpected failure