GET/api/v1/workspaces/{workspace_id}/preview

Preview as someone else

What another person would see in a folder, and what is hidden from them and why. Members can preview; previewing a named person (as set to an email) is for admins.

API token required60 per minute per IP

Code samples and Try it

Path parameters

workspace_idstringRequired
The workspace's id, from the address of its settings page (markdrop.in/settings/workspaces/<workspace-id>) or from List workspaces.

Query parameters

folderstring
Up to 64 characters. Default "root".
as"anyone" | "member" | "email"
Default "anyone".
emailstring
Up to 320 characters.

Responses

200OK.
401No token, or the token is revoked or mistyped.
422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
429Too many requests from your IP address. Wait the seconds in Retry-After.

bash

curl https://api.markdrop.in/api/v1/workspaces/WORKSPACE_ID/preview \
  -H "Authorization: Bearer $MARKDROP_TOKEN"

javascript

const res = await fetch("https://api.markdrop.in/api/v1/workspaces/WORKSPACE_ID/preview", {
  headers: {
    Authorization: `Bearer ${process.env.MARKDROP_TOKEN}`,
  },
});
const data = await res.json();

python

import os

import requests

r = requests.get(
    "https://api.markdrop.in/api/v1/workspaces/WORKSPACE_ID/preview",
    headers={"Authorization": f"Bearer {os.environ['MARKDROP_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

Try it

API token

Kept in this tab only. Without one, the command reads $MARKDROP_TOKEN. Create a token

workspace_idrequired

folder

as

email

Your request

curl https://api.markdrop.in/api/v1/workspaces/WORKSPACE_ID/preview \
  -H "Authorization: Bearer $MARKDROP_TOKEN"

The API accepts browser requests only from markdrop.in, so this page can’t send it for you. Run the command in a terminal.

Did this page help?