Get File Tier 4

GET/api/files/:idCopied!

Returns a single file.

Example

SDK

const file = await client.files.get("FX1234567890ABCD");

CLI

youvico file get --id FX1234567890ABCD

cURL

curl 'https://api.youvico.com/api/files/FX1234567890ABCD' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "data": {
    "id": "FX1234567890ABCD",
    "name": "launch-cut.mp4",
    "description": "Final review upload",
    "mode": "LOCAL",
    "mimeType": "video/mp4",
    "status": "UPLOADED",
    "tag": "NEED_REVIEW",
    "size": 82415032,
    "allowRestricted": true,
    "order": 1,
    "project": {
      "id": "bdbff5de-96d7-468f-9db0-85fe28bd6b62"
    },
    "folder": {
      "id": "DX1234567890ABCD"
    }
  }
}

Request

Path

idstringrequired

File ID

Response

Returns 200 OK.

dataobject

File

data.idstring

File ID

Example: FX1234567890ABCD

data.namestring

File name

Example: launch-cut.mp4

data.descriptionstring?

File description

Example: Final review upload

data.modestring

File source mode

Possible values: LOCALYOUTUBE

Example: LOCAL

data.mimeTypestring?

MIME type

Example: video/mp4

data.statusstring

Upload status

Possible values: UPLOADINGUPLOADEDFAILED

Example: UPLOADED

data.tagstring

Review tag

Possible values: IN_PROGRESSNEED_REVIEWNEED_EDITON_HOLDAPPROVEDREJECTEDCLOSED

Example: NEED_REVIEW

data.sizenumber

File size in bytes

Example: 82415032

data.allowRestrictedboolean

Whether restricted reviewers can access the file

Example: true

data.ordernumber

Display order

Example: 1

data.projectobject

Parent project

data.project.idstring

Parent project ID

Example: bdbff5de-96d7-468f-9db0-85fe28bd6b62

data.folderobject?

Parent folder

data.folder.idstring

Parent folder ID

Example: DX1234567890ABCD