Introducing the Frame.io V4 API Early Access Program <a href='https://forum.frame.io/t/introducing-the-frame-io-v4-api-early-access-program/2407' target='_blank' rel='noopener'>Get started here</a>
List the children (files, folders, and version stacks) in a given folder.
<br>
This endpoint has been added to `Current Version` of the API.
<br>
Please see https://developer.adobe.com/frameio/api/current/#tag/Folders/operation/folders.index.",
<br>
Use the `include` query parameter to selectively include additional properties in the response.
<br>
Note: if you include `media_links.original` and the user does not have permission to download files
in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
If the content is inaccessible because watermarking is required for this user and isn't supported by
the requested media_links, then the request will succeed but the unsupported media links will be set to null.
Similarly, if a requested transcode link does not exist for a particular file (e.g. including
`media_links.video_h264_180` on a static image file) or transoding process hasn't finished
(i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
null in the response payload. In short, the client must handle null media links gracefully.
<br>
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Path parameters
account_idstringRequiredformat: "uuid"
A UUID String
folder_idstringRequiredformat: "uuid"
A UUID String
Headers
api-versionenumRequired
Allowed values:
Query parameters
includeenumOptional
Supported include query parameter values for endpoints that return files with media links
typestringOptional
Type filter for folder children
afterstringOptional
Opaque Cursor query param for requests returning paginated results.
NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
page_sizeintegerOptional1-100Defaults to 50
Page size query param for requests
include_total_countbooleanOptionalDefaults to false
Page query param to include the count of all entities
Response
OK
datalist of objects
Assets
linksobject
Links to paginated data
total_countinteger or null
Total count
Errors
Introducing the Frame.io V4 API Early Access Program Get started here
Use the include query parameter to selectively include additional properties in the response.
Note: if you include media_links.original and the user does not have permission to download files
in the corresponding project, then this endpoint will respond with a 403 Forbidden error.
If the content is inaccessible because watermarking is required for this user and isn’t supported by
the requested media_links, then the request will succeed but the unsupported media links will be set to null.
Similarly, if a requested transcode link does not exist for a particular file (e.g. including
media_links.video_h264_180 on a static image file) or transoding process hasn’t finished
(i.e. the file’s status is “uploaded” rather than “transcoded”), then the a media link will also be set to
null in the response payload. In short, the client must handle null media links gracefully.
Rate Limits: 100 calls per 1.00 minute(s) per account_user