Javascript Reference v1.0

List all files in a bucket

Lists all the files within a bucket.

Policy permissions required:
- buckets permissions: none
- objects permissions: select

Parameters

path

Optional

undefined | string

The folder path.

options

Optional

SearchOptions

Search options, including limit, offset, sortBy, and search.

limit

Optional

undefined | number

The number of files you want to be returned.

offset

Optional

undefined | number

The starting position.

Optional

undefined | string

The search string to filter files by.

sortBy

Optional

SortBy

The column to sort by. Can be any column inside a FileObject.

parameters

Optional

FetchParameters

Fetch parameters, currently only supports signal, which is an AbortController's signal

signal

Optional

AbortSignal


const { data, error } = await supabase
  .storage
  .from('avatars')
  .list('folder', {
    limit: 100,
    offset: 0,
    sortBy: { column: 'name', order: 'asc' },
  })