Fetch child Assets

Get child elements of a given asset. Can be used to get the items in a review link, version stack, folder, as well as including an asset to use on the cover of a folder.

SecurityJWT or OAuth2 or DeveloperToken
Request
path Parameters
asset_id
required
string <uuid>
query Parameters
include_deleted
boolean
Default: "false"

Include deleted files by passing true

include
string

Include additional "pre-loads" for related resources

Enum: "children" "cover_asset" "review_links"
sort
string

The sorting order for the returned list of Assets. Supporting chaining like comment_count,id. Also supports reversing the order with - i.e. -comment_count,id or filetype,-id.

Enum: "comment_count" "filesize" "filetype" "id" "label" "name" "uploaded_at"
page
number

The current page number in this Paginated Response

page_size
number

Number of pages in this Paginated Response

Responses
200

Assets success response

Response Headers
link
string

Pagination links

page-number
integer

Current page of results

per-page
integer

Number of entries per page

total
integer

Total entries across all pagess

total-pages
integer

Number of pages

Response Schema: application/json
Array
account_id
string <uuid>

Account ID this asset belongs to

archive_from
string or null <date-time>
archive_scheduled_at
string or null <date-time>
archive_status
string or null
archived_at
string or null <date-time>
asset_type
string
Enum: "document" "image" "stream"
bundle
boolean
Deprecated
bundle_view
string
Deprecated
cover_asset_id
string <uuid>
object (User)

User model

frames
integer

The number of frames in this asset (really only useful for videos)

hard_deleted_at
string or null <date-time>

Indicates the datetime this asset was hard deleted (30 days after soft-deletion)

id
string <uuid>

The ID for this asset, can be used in places like https://app.frame.io/player/:id to go directly to an asset

index
number <float>

Represented within the Frame.io UI as the "custom sort order" within the grid view

is_bundle_child
boolean
Deprecated

Indicates whether an asset is the child of a bundle asset

is_hls_required
boolean

Indicates whether HLS is required to playback this asset

is_session_watermarked
boolean

Indicates if this asset is subject to Session Based Watermarking (WMID)

item_count
integer

Applies only to folders and version stacks, indicates the number of items in that container

string

Status of the given Asset

metadata
object
object (MetadataFlags)
name
string

Represents the name of the asset (filename)

original
string

This is a URL to download the original asset, or in the event it's subject to watermarking but you still have permission to download - an asset that will be watermarked just-in-time as you download it

parent_asset_id
string <uuid>

The folder that this asset is in

project_id
string <uuid>

The project ID that this asset belongs to

object

Accepts arbitrary key/value pairs for storing information on an asset

object (RequiredTranscodes)
team_id
string <uuid>
object (UserPermissions)
type
string
Enum: "file" "folder" "version_stack" "bundle"
view_count
integer

Not a very helpful number, this really just represents the number of times this asset has been requested via the API

401

Unauthorized response

404

Not Found response

get/v2/assets/{asset_id}/children
Request samples
Response samples
application/json
[
  • {
    }
]