Skip to main content
GET
List the media library

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

kind
enum<string>

Only files of this kind: image, video, audio or font.

Available options:
image,
video,
audio,
font
Example:

"image"

folder
string

Only files in this library folder. Send an empty value for the top folder.

Only files whose name contains this text.

include_parent
enum<string>
default:true

Also list the parent company's files, read only, when this company is a sub-company. Default true.

Available options:
true,
false
Example:

"true"

include_folders
enum<string>
default:false

Also return folders: the company's library folders with how many files each holds (what media-folders lists). Default false.

Available options:
true,
false
Example:

"false"

limit
integer
default:50

Maximum number of records to return (1–1000).

Required range: 1 <= x <= 1000
Example:

50

offset
integer | null
default:0

Number of records to skip from the start of the result set.

Required range: x >= 0
Example:

0

Response

One page of files.

data
object[]
required

Files that finished uploading, newest first.

pagination
object
required
folders
object[]

With include_folders=true: the folders A to Z, empty ones included; the top ("") is not a folder and is not listed.