---
updatedAt: 2025-06-04T21:28:13.000Z
agentTools:
  projectIndex: https://developer.simpplr.com/llms.txt
---

# Fetch video Metadata

Use this API to fetch meta-data of videos

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "staging",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.ec.simpplr.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/contents/video": {
      "get": {
        "summary": "Fetch video Metadata",
        "description": "Use this API to fetch meta-data of videos",
        "operationId": "fetch-video-metadata",
        "parameters": [
          {
            "name": "x-user-email",
            "in": "header",
            "description": "User's email to login into Salesforce",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "site-id",
            "in": "query",
            "description": "Id of the site",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Maximum number of results to return",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "sort-by",
            "in": "query",
            "description": "Technique for sorting results",
            "schema": {
              "type": "string",
              "enum": [
                "createdNewest",
                "createdOldest",
                "modifiedNewest",
                "modifiedOldest",
                "alphabetical"
              ],
              "default": "createdNewest"
            }
          },
          {
            "name": "directory",
            "in": "query",
            "description": "Id of the directory",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"statusCode\": 200,\n    \"message\": \"\",\n    \"videoMetaData\": [\n        {\n            \"title\": \"​﻿⁣file_example_MP4_480_1_5MG.mp4\",\n            \"owner\": {\n                \"url\": \"https://ida-qa-one--simpplr.visualforce.com/apex/Simpplr__app?u=/people/a188c000006m9cCAAQ\",\n                \"name\": \"System Admin\",\n                \"id\": \"a188c000006m9cCAAQ\"\n            },\n            \"size\": 1570024,\n            \"url\": \"https://ida-qa-one--simpplr.visualforce.com/apex/Simpplr__app?u=/video/1_wj5408l5&fileId=1_wj5408l5&provider=native_video\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "statusCode": {
                      "type": "integer",
                      "example": 200,
                      "default": 0
                    },
                    "message": {
                      "type": "string",
                      "example": ""
                    },
                    "videoMetaData": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "title": {
                            "type": "string",
                            "example": "​﻿⁣file_example_MP4_480_1_5MG.mp4"
                          },
                          "owner": {
                            "type": "object",
                            "properties": {
                              "url": {
                                "type": "string",
                                "example": "https://ida-qa-one--simpplr.visualforce.com/apex/Simpplr__app?u=/people/a188c000006m9cCAAQ"
                              },
                              "name": {
                                "type": "string",
                                "example": "System Admin"
                              },
                              "id": {
                                "type": "string",
                                "example": "a188c000006m9cCAAQ"
                              }
                            }
                          },
                          "size": {
                            "type": "integer",
                            "example": 1570024,
                            "default": 0
                          },
                          "url": {
                            "type": "string",
                            "example": "https://ida-qa-one--simpplr.visualforce.com/apex/Simpplr__app?u=/video/1_wj5408l5&fileId=1_wj5408l5&provider=native_video"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"error\",\n    \"message\": \"SESSION_TIMEOUT\",\n    \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    },
                    "i18nmessage": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```