GET/api/v1/documents/{slug}/access

Get sharing settings

Who can open a document and the people it is shared with. People with a role on the document can call it; the list of people is for the owner and editors.

API token required120 per minute per IP

Guide: Who can open a document

Code samples and Try it

Path parameters

#
  • slugstringRequired

    The document's address: the part after markdrop.in/.

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.
200 response: 19 fields (AccessResponse)
  • level"private" | "link" | "workspace"
  • allow_resharingboolean
  • is_password_protectedboolean
  • encryptedboolean

    Set by clients that encrypt in the browser: content and title are already ciphertext. The server never sees the key.

  • in_workspaceboolean
  • workspace_idstring | null
  • workspace_namestring | null
  • folder_idstring | null
  • canobject | null
  • your_role"owner" | "editor" | "viewer"
  • owner_namestring | null
  • owner_emailstring | null
  • your_emailstring | null
  • can_manageboolean
  • can_shareboolean
  • grantsarray of object
    7 fields inside
    • emailstring
    • role"viewer" | "editor"
    • created_atstring (date-time)

      ISO 8601, for example 2026-11-30T12:00:00Z.

    • granted_by_emailstring | null
    • notifiedboolean

      Default false.

    • activeboolean

      Default true.

    • effective_role"viewer" | "editor" | null
  • urlstring | null
  • workspace_urlstring | null
  • expires_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

Did this page help?