Show folder | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.folders.show(
    account_id="9c00a2e6-02c1-4591-af0c-2e4d4ffd9687",
    folder_id="59dbd6d6-ba52-451f-95a5-69ba250567ca",
)

{
  "data": {
    "cover_file_id": "b3b25ab5-2bc6-40f7-9a7d-773ead1054c8",
    "created_at": "2023-09-25T19:18:29.614189Z",
    "id": "67b11ddd-fadc-45f0-ac1d-2f8ae929126c",
    "name": "My Folder",
    "parent_id": "06dd2657-2d56-4c80-afcc-482284725745",
    "project_id": "abdc8443-a4a1-4179-b052-00fe593c841e",
    "type": "folder",
    "updated_at": "2024-02-07T16:44:41.986478Z",
    "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
    "creator": {
      "active": true,
      "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
      "email": "user_email@example.com",
      "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
      "name": "Jon Doe"
    },
    "metadata": [
      {
        "field_type": "select",
        "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          }
        ],
        "field_options": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          },
          {
            "display_name": "Display name 2",
            "id": "1a2dd824-ce0b-4392-9920-c00108675449"
          }
        ]
      }
    ],
    "project": {
      "created_at": "2024-01-25T19:18:29.614189Z",
      "description": "Project Description",
      "id": "3d17f8db-71d7-412b-b3f6-3660dca64b4e",
      "name": "My Project",
      "root_folder_id": "5accdd89-c31f-4fdb-8abe-0d2aa9e3af11",
      "storage": 15000,
      "updated_at": "2024-02-07T16:44:41.986478Z",
      "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
      "workspace_id": "d6afb262-b63c-4f5d-a8f0-36fb90837655",
      "owner": {
        "active": true,
        "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
        "email": "user_email@example.com",
        "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
        "name": "Jon Doe"
      }
    }
  }
}

Show folder details.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequiredformat: "uuid"

A UUID String

folder_idstringRequiredformat: "uuid"

A UUID String

Query parameters

includeenumOptional

Include query parameter for assets

Allowed values:

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error