Tenant

An organisational construct within FuseSign.

PreviousDocument

Last updated 5 months ago

List tenants

get

Get the list of available tenants for the current oauth token

Authorizations

Responses

application/json

object[]Optional

application/json

get

GET /api/Tenant/List HTTP/1.1
Host: localhost:3003
Accept: */*

[
  {
    "Id": "text",
    "Name": "text"
  }
]

Get Billing State

get

Get the tenants Billing State

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

Responses

application/json

objectOptional

application/json

get

GET /api/Tenant/GetBillingState HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "CurrentBillingPlan": {
    "Id": "text",
    "PlanLabel": "text",
    "AllowFuseDocsIntegration": true,
    "IsTrial": true,
    "IsRetired": true,
    "PlanCreditsPerPeriod": 1
  },
  "SubscriptionStatus": "None",
  "CreditSummary": {
    "LastUpdated": "2025-04-19T14:41:32.341Z",
    "CreditsRemaining": 1,
    "NextUpdating": "2025-04-19T14:41:32.341Z"
  }
}

Get Default Settings

get

Get the tenants Default Settings

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

Responses

application/json

objectOptional

application/json

get

GET /api/Tenant/GetDefaultSettings HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "DefaultBundleReminder": "DontRemind",
  "DefaultOverdueBundleReminder": "DontRemind",
  "DefaultViewMode": "SmsToSign",
  "EnabledMixedViewMode": true,
  "DefaultRecipientReceiveMode": "EmailWithAttachments",
  "DefaultCountryCode": "text",
  "EnableDefaultDueDate": true,
  "DefaultDueDateSpan": 1,
  "DefaultSigningMode": "SignWhole",
  "DefaultRejectionMode": "RejectDocumentAllowBundleFinalisation",
  "DefaultSMSNotificationMode": "Off"
}

Get Teams

get

Get the list of a tenants teams (accessible to the logged in user)

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

Responses

application/json

object[]Optional

application/json

get

GET /api/Tenant/GetTeams HTTP/1.1
Host: localhost:3003
Accept: */*

[
  {
    "Id": "text",
    "Name": "text"
  }
]