Nurama Developers
Projects

Get public file systems for a project

Retrieves a paginated list of public file systems for a project with support for search, filtering, and both cursor and index-based pagination. Requires `canGetPublicFileSystem`. Cursor-only parameters are rejected with index pagination and `page` is rejected with cursor pagination.

GET
/projects/{projectId}/public

Retrieves a paginated list of public file systems for a project with support for search, filtering, and both cursor and index-based pagination. Requires canGetPublicFileSystem. Cursor-only parameters are rejected with index pagination and page is rejected with cursor pagination.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Unique ID of the project.

Formatuuid

Query Parameters

paginate?string

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

Default"index"

Value in

  • "cursor"
  • "index"
search?string

Search public file systems by title and description (case-insensitive substring match; whitespace trimmed).

Lengthlength <= 200
status?|array<>

Filter by status (single value, comma-separated string or array). The unreleased status is manager-only — it is silently stripped for callers without canCreatePublicFileSystem.

Default

[  "active",  "expired",  "unreleased"]
creatorId?string

Filter by creator ID

Formatuuid
sort?

Sorting criteria for public file systems

Default

{  "updatedAt": -1}
limit?number

Number of results per page

Rangevalue <= 100
Default20
page?number

Page number (only accepted with paginate=index).

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).

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/public"
{  "page": 0,  "limit": 0,  "totalPages": 0,  "totalResults": 0,  "queryAt": 0,  "results": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "ownerResourceType": "project",      "ownerResourceId": "7d5ad1db-89f9-42df-868c-86a72347ae1c",      "token": "string",      "title": "string",      "description": "string",      "inventory": {        "image": 12,        "video": 2,        "folder": 3      },      "status": "active",      "expires": "2019-08-24T14:15:22Z",      "hideCreators": true,      "allowAnonymousComments": true,      "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",      "creator": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "firstName": "string",        "middleName": "string",        "lastName": "string",        "company": "string",        "userName": "string",        "displayName": "string",        "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67",        "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779",        "color": "#ffffff",        "email": "user@example.com",        "isEmailVerified": false,        "hasPassword": false,        "allowOauthAutolink": true,        "mfaEnabled": false,        "mfaType": "totp",        "status": "active",        "accountType": "standard",        "globalRoles": [          "string"        ],        "preferences": {},        "language": "en",        "externalIds": {},        "lastSeen": "2019-08-24T14:15:22Z",        "hasUsedTrial": false,        "hasUsedDemo": false,        "hasSeen": [          "string"        ],        "awards": [          "staff"        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}