Nurama Developers
Projects

Get items at a specific path within a project

Same as the root listing, scoped to a folder path. Path segments may be folder slugs or IDs (IDs are resolved to slugs; an unknown segment returns `fileSystemPathNotFound`, 404). Virtual paths are supported: `Public` and `Submission` list one synthesized sub-folder per release / submission the caller may read (`canGetPublicFileSystem` / `canGetSubmission`), and `Public/{token}/...`, `Submission/{id}/...` and `Review/...` are translated to the underlying tree. Requires `canGetCreatorItems` for `creator` and `canGetReviewerItems` for `reviewer`.

GET
/projects/{projectId}/files/{visibility}/{path}

Same as the root listing, scoped to a folder path. Path segments may be folder slugs or IDs (IDs are resolved to slugs; an unknown segment returns fileSystemPathNotFound, 404). Virtual paths are supported: Public and Submission list one synthesized sub-folder per release / submission the caller may read (canGetPublicFileSystem / canGetSubmission), and Public/{token}/..., Submission/{id}/... and Review/... are translated to the underlying tree. Requires canGetCreatorItems for creator and canGetReviewerItems for reviewer.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

0*string
projectId*string

Unique ID of the project.

Formatuuid
visibility*string

Which tree to operate on — the creator tree or the reviewer tree.

Value in

  • "creator"
  • "reviewer"
path*string

Folder path within the tree. May contain several /-separated segments; each segment is a folder slug or ID.

Query Parameters

paginate?string

Pagination mode. Cursor-only parameters are rejected when index; page is rejected when cursor.

Default"index"

Value in

  • "cursor"
  • "index"
recursiveSearch?boolean

If true, includes items in every sub-folder beneath the path instead of only direct children.

resourceIds?array<>|

Filter by specific resource IDs. May not be combined with resourceSlugs.

Default[]
resourceSlugs?array<>|

Filter by specific resource slugs. May not be combined with resourceIds.

Default[]
resourceType?string

Filter by resource type

Value in

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

Filter by tag IDs

Default[]
creatorId?string

Filter by the resource creator's user ID

Formatuuid
mediaTypes?array<>|

Filter by media types (single value or array)

Default[]
resourceStatus?string

Filter by resource status

Default"active"

Value in

  • "active"
  • "pendingDelete"
nameSearch?string

Partial, case-insensitive match on the resource name

Lengthlength <= 100
sort?

Sorting criteria. Keys are mapped onto the FileSystem entry's resource fields (name → resourceName, createdAt → resourceCreatedAt, ...).

Default

{  "id": -1}
limit?number

Number of results per page

Range1 <= value <= 100
Default10
cursor?string

Cursor for pagination (only accepted with paginate=cursor).

paginateReverse?boolean

If true, paginates in reverse order (only accepted with paginate=cursor).

includeCounts?boolean

If true, includes count information (only accepted with paginate=cursor).

includeCursorRecord?boolean

If true, includes the cursor record in results (only accepted with paginate=cursor).

startAt?string

ID of the record to start pagination from (only accepted with paginate=cursor).

Formatuuid
includeStartAtRecord?boolean

If true, includes the startAt record in the results (only accepted with paginate=cursor).

page?number

Page number (only accepted with paginate=index)

Range1 <= value

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/creator/Renders/2024"
{  "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 project feed with assets and chats GET

Previous Page

Get items at the root path of a project GET

Next Page