Skip to Content
put.ioDevelopers
Register an app

List files

GEThttps://api.put.io/v2/files/list

Query

parent_idinteger

List files under a folder. If not specified, files at root folder will be listed. Listing is not recursive. However, if you pass "-1", all files of the user will be returned. If you pass "-1", make sure that you also specify per_page param to make use of cursor.

per_pageinteger

Number of files to be returned in response. If not specified cursor will always be null and no more than 2000 items will be returned.

sort_bystring · enum

Sort order of files in response. If not specified, the value saved in user settings will be used.

NAME_ASCNAME_DESCSIZE_ASCSIZE_DESCDATE_ASCDATE_DESCMODIFIED_ASCMODIFIED_DESCTYPE_ASCTYPE_DESCWATCH_ASCWATCH_DESC
content_typestring

Filter files by content type.

file_typearray

Filter files by file type.

stream_urlboolean

Include stream_url in files array.

stream_url_parentboolean

Include stream_url in parent object.

mp4_stream_urlboolean

Include mp4_stream_url in files array.

mp4_stream_url_parentboolean

Currently has no effect. Use mp4_status_parent to include mp4_stream_url in parent object.

hiddenboolean

Folders such as "Your friends files" at root and folders in it are hidden by default if they are empty. If you want to include them in response, you can pass true.

mp4_statusboolean

Include mp4_size and need_convert fields in response.

mp4_status_parentboolean

Include mp4_size, need_convert and mp4_stream_url in parent object.

codecs_parentboolean

Include codec info in parent object.

media_info_parentboolean

Include media info in parent object.

video_metadataboolean

Include video_metadata in files array.

video_metadata_parentboolean

Include video_metadata in parent object.

media_metadataboolean

Include media_metadata in files array.

media_metadata_parentboolean

Include media_metadata in parent object.

sortstring

Alias of sort_by. Used only when sort_by is absent.

breadcrumbsboolean

Include breadcrumbs in response. Not allowed with parent_id=-1.

no_cursorboolean

Do not return a cursor, even when per_page is set.

Returns

200

filesarray
parentobject | null

null when parent_id=-1.

totalinteger
cursorstring | null

Cursor value for fetching next page. You have to specify "per_page" param to get a cursor. Otherwise, it will always be null.

breadcrumbsarray

[id, name] pairs of the parent folder's ancestors, starting at root. Present only when breadcrumbs=true is passed.

Errors

JSON with error_type, error_message, error_id and extra.

429Too many requests. Limits are per token and per IP. Wait until X-RateLimit-Reset, then retry.