Shared Folders

Folders shared with read or read+write access.

On this page

getView shared folder/folders/shared/{token}
getList shared folder bookmarks/folders/shared/{token}/bookmarks
postCreate shared folder bookmark/folders/shared/{token}/bookmarks
deleteDelete shared folder bookmark/folders/shared/{token}/bookmarks/{bookmarkId}
getGet shared folder bookmark/folders/shared/{token}/bookmarks/{bookmarkId}
patchUpdate shared folder bookmark/folders/shared/{token}/bookmarks/{bookmarkId}
getList folder shares/workspaces/{workspaceId}/folders/{folderId}/shares
postCreate folder share/workspaces/{workspaceId}/folders/{folderId}/shares
deleteRevoke folder share/workspaces/{workspaceId}/folders/{folderId}/shares/{shareId}

View shared folder

Returns shared folder metadata for an unauthenticated share link token.

Technical details

Exact HTTP method and path your client calls

get/folders/shared/{token}

Path parameters

Name	Type	Required	Description
token	string	required

Responses

Shared folder and bookmarks

Field	Type	Description
	object
	Bookmark[]
permission	string	enum: `readread_write`

Example

{
  "folder": {
    "id": "string",
    "tenantId": "string",
    "workspaceId": "string",
    "name": "string",
    "parentId": "string",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  },
  "bookmarks": [
    {
      "id": "string",
      "tenantId": "string",
      "workspaceId": "string",
      "url": "string",
      "title": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "folderId": "string",
      "sortOrder": 0,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "linkStatus": "ok",
      "lastLinkCheckedAt": "2026-01-01T00:00:00.000Z",
      "snapshotEnabled": false,
      "readerExcerpt": "string",
      "videoEmbedUrl": "string",
      "archive": {
        "status": "none",
        "retentionExpiresAt": "2026-01-01T00:00:00.000Z",
        "metadataId": "string"
      }
    }
  ],
  "permission": "read"
}

Errors return the standard envelope. See error reference.

Code samples

curl --request GET \
  --url 'https://api.not24get.me/folders/shared/%3Atoken' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json'

Try it

Path parameters

token*

List shared folder bookmarks

Lists bookmarks visible through a shared folder link.

Technical details

Exact HTTP method and path your client calls

get/folders/shared/{token}/bookmarks

Path parameters

Name	Type	Required	Description
token	string	required

Responses

200

Field	Type	Description
	Bookmark[]
	object	Bookmark in a workspace (serialized API shape).

Example

[
  {
    "id": "string",
    "tenantId": "string",
    "workspaceId": "string",
    "url": "string",
    "title": "string",
    "description": "string",
    "tags": [
      "string"
    ],
    "folderId": "string",
    "sortOrder": 0,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "linkStatus": "ok",
    "lastLinkCheckedAt": "2026-01-01T00:00:00.000Z",
    "snapshotEnabled": false,
    "readerExcerpt": "string",
    "videoEmbedUrl": "string",
    "archive": {
      "status": "none",
      "retentionExpiresAt": "2026-01-01T00:00:00.000Z",
      "metadataId": "string"
    }
  }
]

Errors return the standard envelope. See error reference.

Code samples

curl --request GET \
  --url 'https://api.not24get.me/folders/shared/%3Atoken/bookmarks' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json'

Try it

Path parameters

token*

Create shared folder bookmark

Creates a bookmark inside a read-write shared folder link.

Technical details

Exact HTTP method and path your client calls

post/folders/shared/{token}/bookmarks

Path parameters

Name	Type	Required	Description
token	string	required

Request body

Field	Type	Description
url	string
title	string
description	string
tags	string[]
folderId	string
archiveCapture	boolean

Responses

201

Field	Type	Description
id	string
tenantId	string
workspaceId	string
url	string
title	string
description	string
tags	string[]
folderId	string
sortOrder	integer
createdAt	string<date-time> · date-time
updatedAt	string<date-time> · date-time
linkStatus	string	enum: `okdeadunknown`
lastLinkCheckedAt	string<date-time> · date-time
snapshotEnabled	boolean
readerExcerpt	string
videoEmbedUrl	string
	object

Example

{
  "id": "string",
  "tenantId": "string",
  "workspaceId": "string",
  "url": "string",
  "title": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "folderId": "string",
  "sortOrder": 0,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "linkStatus": "ok",
  "lastLinkCheckedAt": "2026-01-01T00:00:00.000Z",
  "snapshotEnabled": false,
  "readerExcerpt": "string",
  "videoEmbedUrl": "string",
  "archive": {
    "status": "none",
    "retentionExpiresAt": "2026-01-01T00:00:00.000Z",
    "metadataId": "string"
  }
}

Errors return the standard envelope. See error reference.

Code samples

curl --request POST \
  --url 'https://api.not24get.me/folders/shared/%3Atoken/bookmarks' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "string",
  "title": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "folderId": "string",
  "archiveCapture": false
}'

Try it

Path parameters

token*

Request body (JSON)

Delete shared folder bookmark

Deletes a bookmark when the share link grants write access.

Technical details

Exact HTTP method and path your client calls

delete/folders/shared/{token}/bookmarks/{bookmarkId}

Path parameters

Name	Type	Required	Description
token	string	required
bookmarkId	string	required

Responses

204

Field	Type	Description
(value)	EmptyResponsePart

Example

null

Errors return the standard envelope. See error reference.

Code samples

curl --request DELETE \
  --url 'https://api.not24get.me/folders/shared/%3Atoken/bookmarks/%3AbookmarkId' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json'

Try it

Path parameters

token*bookmarkId*

Get shared folder bookmark

Returns one bookmark from a shared folder link.

Technical details

Exact HTTP method and path your client calls

get/folders/shared/{token}/bookmarks/{bookmarkId}

Path parameters

Name	Type	Required	Description
token	string	required
bookmarkId	string	required

Responses

200

Field	Type	Description
id	string
tenantId	string
workspaceId	string
url	string
title	string
description	string
tags	string[]
folderId	string
sortOrder	integer
createdAt	string<date-time> · date-time
updatedAt	string<date-time> · date-time
linkStatus	string	enum: `okdeadunknown`
lastLinkCheckedAt	string<date-time> · date-time
snapshotEnabled	boolean
readerExcerpt	string
videoEmbedUrl	string
	object

Example

{
  "id": "string",
  "tenantId": "string",
  "workspaceId": "string",
  "url": "string",
  "title": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "folderId": "string",
  "sortOrder": 0,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "linkStatus": "ok",
  "lastLinkCheckedAt": "2026-01-01T00:00:00.000Z",
  "snapshotEnabled": false,
  "readerExcerpt": "string",
  "videoEmbedUrl": "string",
  "archive": {
    "status": "none",
    "retentionExpiresAt": "2026-01-01T00:00:00.000Z",
    "metadataId": "string"
  }
}

Errors return the standard envelope. See error reference.

Code samples

curl --request GET \
  --url 'https://api.not24get.me/folders/shared/%3Atoken/bookmarks/%3AbookmarkId' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json'

Try it

Path parameters

token*bookmarkId*

Update shared folder bookmark

Updates a bookmark when the share link grants write access.

Technical details

Exact HTTP method and path your client calls

patch/folders/shared/{token}/bookmarks/{bookmarkId}

Path parameters

Name	Type	Required	Description
token	string	required
bookmarkId	string	required

Request body

Field	Type	Description
url	string
title	string
description	string
tags	string[]
folderId	string
archiveCapture	boolean
noticeVersion	string
sortOrder	integer
snapshotEnabled	boolean
readerExcerpt	string
videoEmbedUrl	string

Responses

200

Field	Type	Description
id	string
tenantId	string
workspaceId	string
url	string
title	string
description	string
tags	string[]
folderId	string
sortOrder	integer
createdAt	string<date-time> · date-time
updatedAt	string<date-time> · date-time
linkStatus	string	enum: `okdeadunknown`
lastLinkCheckedAt	string<date-time> · date-time
snapshotEnabled	boolean
readerExcerpt	string
videoEmbedUrl	string
	object

Example

{
  "id": "string",
  "tenantId": "string",
  "workspaceId": "string",
  "url": "string",
  "title": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "folderId": "string",
  "sortOrder": 0,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "linkStatus": "ok",
  "lastLinkCheckedAt": "2026-01-01T00:00:00.000Z",
  "snapshotEnabled": false,
  "readerExcerpt": "string",
  "videoEmbedUrl": "string",
  "archive": {
    "status": "none",
    "retentionExpiresAt": "2026-01-01T00:00:00.000Z",
    "metadataId": "string"
  }
}

Errors return the standard envelope. See error reference.

Code samples

curl --request PATCH \
  --url 'https://api.not24get.me/folders/shared/%3Atoken/bookmarks/%3AbookmarkId' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "string",
  "title": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "folderId": "string",
  "archiveCapture": false,
  "noticeVersion": "string",
  "sortOrder": 0,
  "snapshotEnabled": false,
  "readerExcerpt": "string",
  "videoEmbedUrl": "string"
}'

Try it

Path parameters

token*bookmarkId*

Request body (JSON)

List folder shares

Lists active share links for a folder.

Technical details

Exact HTTP method and path your client calls

get/workspaces/{workspaceId}/folders/{folderId}/shares

Path parameters

Name	Type	Required	Description
workspaceId	string	required
folderId	string	required

Headers

Name	Type	Required	Description
X-Workspace-ID	string	optional	Target workspace when the API key is tenant-wide or to disambiguate scope.

Responses

200

Field	Type	Description
	FolderShare[]
	object

Example

[
  {
    "id": "string",
    "permission": "read",
    "token": "string",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "expiresAt": "2026-01-01T00:00:00.000Z",
    "shareUrl": "https://example.com"
  }
]

Errors return the standard envelope. See error reference.

Code samples

curl --request GET \
  --url 'https://api.not24get.me/workspaces/%3AworkspaceId/folders/%3AfolderId/shares' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-ID: <workspace-id>'

Try it

Path parameters

workspaceId*folderId*

Headers

X-Workspace-ID

This endpoint requires a workspace ID. Set one in the API key dialog.

Create folder share

Creates a read-only or read-write share link for a folder.

Technical details

Exact HTTP method and path your client calls

post/workspaces/{workspaceId}/folders/{folderId}/shares

Path parameters

Name	Type	Required	Description
workspaceId	string	required
folderId	string	required

Headers

Name	Type	Required	Description
X-Workspace-ID	string	optional	Target workspace when the API key is tenant-wide or to disambiguate scope.

Request body

Field	Type	Description
permissionrequired	string	enum: `readread_write`

Responses

201

Field	Type	Description
id	string
permission	string	enum: `readread_write`
createdAt	string<date-time> · date-time
expiresAt	string<date-time> · date-time
token	string
shareUrl	string<uri> · uri

Example

{
  "id": "string",
  "permission": "read",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "expiresAt": "2026-01-01T00:00:00.000Z",
  "token": "string",
  "shareUrl": "https://example.com"
}

Errors return the standard envelope. See error reference.

Code samples

curl --request POST \
  --url 'https://api.not24get.me/workspaces/%3AworkspaceId/folders/%3AfolderId/shares' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-ID: <workspace-id>' \
  --data '{
  "permission": "read"
}'

Try it

Path parameters

workspaceId*folderId*

Headers

X-Workspace-ID

Request body (JSON)

This endpoint requires a workspace ID. Set one in the API key dialog.

Revoke folder share

Revokes an active folder share link. Returns no body on success.

Technical details

Exact HTTP method and path your client calls

delete/workspaces/{workspaceId}/folders/{folderId}/shares/{shareId}

Path parameters

Name	Type	Required
workspaceId	string	required
folderId	string	required
shareId	string	required

Headers

Name	Type	Required	Description
X-Workspace-ID	string	optional	Target workspace when the API key is tenant-wide or to disambiguate scope.

Responses

204

Field	Type	Description
(value)	EmptyResponsePart

Example

null

Errors return the standard envelope. See error reference.

Code samples

curl --request DELETE \
  --url 'https://api.not24get.me/workspaces/%3AworkspaceId/folders/%3AfolderId/shares/%3AshareId' \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-ID: <workspace-id>'

Try it

Path parameters

workspaceId*folderId*shareId*

Headers

X-Workspace-ID

This endpoint requires a workspace ID. Set one in the API key dialog.