Skip to main content
GET
/
files
List files
curl --request GET \
  --url https://api-staging.pixwel.com/api/files \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'X-Range: <x-range>'
[
  {
    "_id": "5697b31595fa09bc2e8b4586",
    "studio": "53d198844f06409d418b4571",
    "project": "55b6d17a36ab4620718b4570",
    "asset": "568f80f07d1f4683168b4575",
    "name": "13HOURS_FEATURETTE_TANTO-AND-PABLO_ENG-UK_JAN29_H264_1080p.mov",
    "language": "ENG",
    "country": "UK",
    "tags": [
      "h264"
    ],
    "path": "par-limited/13hours/featurette/13HOURS_FEATURETTE_TANTO-AND-PABLO_ENG-UK_JAN29_H264_1080p.mov",
    "verified": true,
    "embargo": {
      "event": true,
      "end": 1452783600
    },
    "warnings": [
      "<unknown>"
    ],
    "aspera": {
      "username": "pixwel"
    },
    "created": 1452782357,
    "$flags": [
      "<unknown>"
    ],
    "$links": {
      "self": "//api-staging.pixwel.com/api/Files/5697b31595fa09bc2e8b4586",
      "project": "//api-staging.pixwel.com/api/Projects/13hours",
      "asset": "//api-staging.pixwel.com/api/Assets/568f80f07d1f4683168b4575"
    },
    "$aspera": {
      "downloaded": false
    }
  }
]

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Range
string
default:resources=0-9
required

Pagination range (e.g. resources=0-9, resources=10-19)

Query Parameters

id
string
studio
string
project
string
asset
string
workRequest
string
field
string
tags
string

Response

200 - application/json

OK

_id
string
Example:

"5697b31595fa09bc2e8b4586"

studio
string
Example:

"53d198844f06409d418b4571"

project
string
Example:

"55b6d17a36ab4620718b4570"

asset
string
Example:

"568f80f07d1f4683168b4575"

name
string
Example:

"13HOURS_FEATURETTE_TANTO-AND-PABLO_ENG-UK_JAN29_H264_1080p.mov"

language
string
Example:

"ENG"

country
string
Example:

"UK"

tags
string[]
path
string
Example:

"par-limited/13hours/featurette/13HOURS_FEATURETTE_TANTO-AND-PABLO_ENG-UK_JAN29_H264_1080p.mov"

verified
boolean
Example:

true

embargo
object
warnings
any[]
aspera
object
created
integer
Example:

1452782357

$flags
any[]
$aspera
object