Docmost.Sdk 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Docmost.Sdk --version 1.0.0
                    


                    

                
NuGet\Install-Package Docmost.Sdk -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Docmost.Sdk" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Docmost.Sdk" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Docmost.Sdk" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Docmost.Sdk --version 1.0.0
                    


                    

                
#r "nuget: Docmost.Sdk, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Docmost.Sdk@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Docmost.Sdk&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Docmost.Sdk&version=1.0.0
                    


                            Install as a Cake Tool

Docmost.Sdk

.NET client library for the Docmost REST API.

Installation

dotnet add package Docmost.Sdk

Or reference the project locally:

dotnet add reference path/to/Docmost.Sdk.csproj

Quick start

API token (Bearer)

using Docmost.Sdk;

await using var client = new DocmostClient("https://docs.example.com", apiToken: "your-api-key");

var me = await client.Users.GetUserInfoAsync();
var user = me.Data; // JsonElement — deserialize to your types or use extension helpers

await using var client = new DocmostClient(
    "https://docs.example.com",
    email: "admin@example.com",
    password: "secret");

var spaces = await client.Spaces.GetWorkspaceSpacesAsync(
    new PaginationOptions { Limit = 20 });

Advanced configuration

using Docmost.Sdk;

var client = new DocmostClient(new DocmostClientOptions
{
    BaseUrl = new Uri("https://docs.example.com"),
    ApiToken = Environment.GetEnvironmentVariable("DOCMOST_API_TOKEN"),
    Timeout = TimeSpan.FromSeconds(60),
    LoginOnStartup = false,
});

await client.LoginAsync(); // when using email/password

API surface

DocmostClient exposes grouped clients matching the OpenAPI tags:

Property Description
Auth Login, logout, password reset, setup
Users Current user profile
Workspace Workspace settings, members, invites
Spaces Spaces and membership
Pages Pages, history, tree
Comments Page comments
Attachments Uploads and file downloads
Search Full-text search
Shares Public sharing
Groups User groups
Export / Import Export and import
Health / Version Health and version
ApiKeys, Mfa, License, Sso, Ai, Cloud Enterprise features

All POST endpoints return ApiResponse<JsonElement?>. Use System.Text.Json to map Data to strongly typed models from Docmost.Sdk.Models.

Building & publishing to NuGet

cd c#
dotnet pack src/Docmost.Sdk/Docmost.Sdk.csproj -c Release
dotnet nuget push src/Docmost.Sdk/bin/Release/Docmost.Sdk.1.0.0.nupkg --api-key <key> --source https://api.nuget.org/v3/index.json

License

MIT

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 121 5/21/2026