Skip to content
API Reference/
/
List assets

List assets

Request

Browse workspace assets and folders with separate pagination. Use scope=project with projectId for project membership; scope=trash lists recoverable deleted assets. Paths may be stored relative to the content CDN.

Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

Example:693fb82afd8d1c43077ba0fb
workspaceIdstringrequired

Unique identifier for the workspace

Example:693fb82afd8d1c43077ba0fe
Query
filterByTypestring

Filter by media type prefix.

folderNamestring

Folder path, for example /.

searchstring
limitinteger, >= 1
Default:10
assetPageinteger, >= 1
Default:1
folderPageinteger, >= 1
Default:1
scopestring
Default:"workspace"
Enum:"workspace""project""trash"
projectIdstring

Required for project scope.

collectionstring
Default:"all"
Enum:"all""recent""generated""used"
sortBystring
sortDirectionstring
Enum:"asc""desc"
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/apis/auth/organization/693fb82afd8d1c43077ba0fb/workspace/693fb82afd8d1c43077ba0fe/assets?filterByType=string&folderName=string&search=string&limit=10&assetPage=1&folderPage=1&scope=workspace&projectId=string&collection=all&sortBy=string&sortDirection=asc' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved assets.

Bodyapplication/json
foldersobject(AssetPage)
assetsobject(AssetPage)
paginationobject
Response
{
  "folders": {
    "items": [],
    "total": 0,
    "page": 1,
    "limit": 10
  },
  "assets": {
    "items": [ … ],
    "total": 2,
    "page": 1,
    "limit": 10
  },
  "pagination": {
    "folders": { … },
    "assets": { … }
  }
}