Nurama Developers
Public

Get public file system items at path

Retrieves items (assets and folders) from a public file system at a specific folder path. No authentication required. Accepts the same query parameters as `GET /public/{token}/files`. When the release was created with `hideCreators: true`, each item's creator fields are omitted.

GET
/public/{token}/files/{path}

Retrieves items (assets and folders) from a public file system at a specific folder path. No authentication required. Accepts the same query parameters as GET /public/{token}/files. When the release was created with hideCreators: true, each item's creator fields are omitted.

Path Parameters

0*string
token*string

The 10-character access token for the public file system.

Match^[a-zA-Z0-9]{10}$
Length10 <= length <= 10
path*string

The folder path to browse (supports nested paths). Segments may be folder slugs or folder IDs; IDs are resolved to slugs before lookup.

Query Parameters

paginate?string

Pagination type to use

Default"index"

Value in

  • "cursor"
  • "index"
recursiveSearch?boolean

Whether to search recursively through subfolders

resourceIds?array<>|

Restrict results to these asset/folder IDs. A single value or repeated parameter.

Default[]
resourceSlugs?array<>|

Restrict results to these resource slugs. A single value or repeated parameter.

Default[]
resourceType?string

Filter by resource type

Value in

  • "asset"
  • "folder"
resourceTags?array<>|

Filter by tag IDs. A single value or repeated parameter.

Default[]
creatorId?string

Filter by the ID of the user who created the resource

Formatuuid
mediaTypes?array<>|

Filter by media types. A single value or repeated parameter.

Default[]
resourceStatus?string

Filter by resource status

Default"active"

Value in

  • "active"
  • "pendingDelete"
nameSearch?string

Search items by name

Lengthlength <= 100
sort?

Sort order, e.g. sort[name]=1. Keys are mapped onto the underlying file-system item fields.

Default

{  "id": -1}
limit?number

Number of items per page

Range1 <= value <= 100
Default10
cursor?string

Cursor for pagination (cursor pagination only; rejected when paginate=index)

paginateReverse?boolean

Whether to paginate in reverse order (cursor pagination only)

includeCounts?boolean

Whether to include total counts (cursor pagination only)

includeCursorRecord?boolean

Whether to include the cursor record itself (cursor pagination only)

startAt?string

Start at a specific file-system item ID (cursor pagination only)

Formatuuid
includeStartAtRecord?boolean

Whether to include the startAt record (cursor pagination only)

page?number

Page number (index pagination only; rejected when paginate=cursor)

Range1 <= value

Response Body

application/json

application/json

curl -X GET "https://example.com/public/abc123xyz0/files/string"
{  "page": 0,  "limit": 0,  "totalPages": 0,  "totalResults": 0,  "queryAt": 0,  "results": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",      "resourceType": "asset",      "resourceName": "string",      "resourceSlug": "string",      "resourceCreatorId": "b999e32f-d7f6-4b84-a6e4-838d107690fd",      "resourceTags": [        "2c6ab259-75b1-40bd-909b-bdecda587146"      ],      "resourceMediaType": "string",      "resourceStatus": "active",      "resourceCreatedAt": "2019-08-24T14:15:22Z",      "sizeInBytes": 0,      "path": "string",      "itemPath": "string",      "pathType": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "resource": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "ownerResourceId": "7d5ad1db-89f9-42df-868c-86a72347ae1c",        "ownerResourceType": "workspace",        "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",        "creator": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "firstName": "string",          "lastName": "string",          "displayName": "string",          "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779",          "color": "string",          "awards": [            "staff"          ],          "accountType": "standard"        },        "fileSystemPaths": [          "string"        ],        "basePath": "string",        "noFileSystem": false,        "keyPath": "string",        "checksum": "string",        "checksumAlgorithm": "md5",        "name": "string",        "slug": "string",        "functionType": "attachment",        "mediaType": "image",        "tags": [],        "files": [          {            "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",            "keyPath": "/project/asset/file123.jpg",            "checksum": "string",            "checksumAlgorithm": "md5",            "name": "string",            "functionType": "original",            "sizeInBytes": 0,            "status": "active",            "meta": {},            "createdAt": 1678886400000,            "updatedAt": 1678886400000          }        ],        "chats": {          "creatorLastMessageAt": "2019-08-24T14:15:22Z",          "reviewerLastMessageAt": "2019-08-24T14:15:22Z",          "creator": "1dccd4a6-75d2-43aa-a088-76d941f1b60a",          "reviewer": "a4b7b7a3-a1d0-4e27-9161-fa5679d1e0d6"        },        "expectedUploadSizeInMB": 0,        "sizeInBytes": 0,        "visibility": [          "creator"        ],        "publishedOn": 1678886400000,        "publisherId": "f1ba8124-cabe-46cd-b4f9-1189594ff7b3",        "publisher": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "firstName": "string",          "lastName": "string",          "displayName": "string",          "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779",          "color": "string",          "awards": [            "staff"          ],          "accountType": "standard"        },        "hasActivePublicLink": false,        "hasActivePublicFileSystem": false,        "everPublic": false,        "publicFileSystemIds": [          "3a3392f6-5ad7-429c-8b57-759911bd1423"        ],        "publicAssetLinkIds": [          "35788e46-f1b0-471c-b8ec-69afab5a9e64"        ],        "submissionFileSystemIds": [          "c658ae43-33f0-4032-85f0-ea3242de6509"        ],        "aiGenerated": false,        "promotedFromAssetId": "c833ed16-de04-406f-a750-9ed1e24820b3",        "contentSnippet": "string",        "status": "active",        "meta": {},        "inheritanceId": "09c886ac-e6e5-4263-a494-a6e14f7e4f46",        "inheritance": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",          "resourceType": "string",          "inheritance": {            "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b": "workspace",            "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6c": "project"          },          "inheritanceInverted": {            "property1": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "property2": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "path": "string",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        },        "createdAt": 1678886400000,        "updatedAt": 1678886400000      }    }  ]}

Get main public file system chat GET

Previous Page

Get public file system items GET

Next Page