GET/api/v1/workspaces/{workspace_id}

Get a workspace

A workspace's name, branding, settings and your role in it.

API token required120 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.

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: 15 fields (WorkspaceResponse)
  • idstring
  • namestring
  • owner_idstring
  • created_atstring (date-time)

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

  • updated_atstring (date-time)

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

  • brandingobject

    Every field optional — an unset workspace looks exactly like Markdrop.

    6 fields inside
    • site_namestring | null

      Up to 60 characters.

    • favicon_urlstring | null

      Up to 500 characters.

    • logo_urlstring | null

      Up to 500 characters.

    • accent_colorstring | null

      Matches ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$.

    • hide_markdrop_brandingboolean

      Default false.

    • logo_well"light" | "dark" | "checker" | null
  • settingsobject
    4 fields inside
    • viewer_chrome"full" | "minimal" | "none"

      Default "full".

    • require_auth_to_viewboolean

      Default false.

    • members_can_share_foldersboolean

      Default true.

    • default_access"link" | "workspace" | "private"

      Default "workspace".

  • role"owner" | "admin" | "member" | "viewer"
  • primary_hoststring | null
  • domainsarray of object
    9 fields inside
    • hoststring
    • kindstring | null
    • statusstring

      Default "pending".

    • verifiedboolean
    • primaryboolean
    • liveboolean
    • txt_okboolean | null
    • routing_okboolean | null
    • failuresinteger

      Default 0.

  • default_accessstring

    Default "workspace".

  • privacystring

    Default "custom".

  • member_countinteger

    Default 0.

  • pending_invite_countinteger

    Default 0.

  • domain_countinteger

    Default 0.

Did this page help?