> For the complete documentation index, see [llms.txt](https://fuseworks.gitbook.io/fusesign/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fuseworks.gitbook.io/fusesign/api-references/tenant.md).

# Tenant

## List tenants

> Get the list of available tenants for the current OAuth token

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesTenantTenantListGetTenantListResponse_TenantDto":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string","description":"Tenant ID","format":"guid"},"Name":{"type":"string","description":"Tenant Name"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Tenant/List":{"get":{"tags":["Tenant"],"summary":"List tenants","description":"Get the list of available tenants for the current OAuth token","operationId":"ExternalApiExternalHandlersFeaturesTenantTenantListGetTenantListEndpoint","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesTenantTenantListGetTenantListResponse_TenantDto"}}}}},"400":{"description":"Error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Produce a summary of the billing state of a given FuseSign tenant.

> Produces the summary of the billing state for this tenant. The requesting user must be a FuseSign user to access this information. A credit consumed summary is also produced

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"FuseWebExternalCoreModelsExternalBillingStatus":{"type":"object","additionalProperties":false,"properties":{"CurrentBillingPlan":{"description":"Tenants Billing plan information","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebExternalCoreModelsExternalBillingPlan"}]},"SubscriptionStatus":{"description":"Tenants current subscription state information","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSubscriptionStatus"}]},"CreditSummary":{"description":"Tenants credit summary information","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebExternalCoreModelsExternalCreditSummary"}]}}},"FuseWebExternalCoreModelsExternalBillingPlan":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string","format":"guid"},"PlanLabel":{"type":"string","nullable":true},"AllowFuseDocsIntegration":{"type":"boolean"},"IsTrial":{"type":"boolean"},"IsRetired":{"type":"boolean"},"PlanCreditsPerPeriod":{"type":"integer","format":"int32"}}},"FuseWebSharedObjectsFuseSignEnumsSubscriptionStatus":{"type":"string","description":"","enum":["None","CreatedButUnpaid","Active","Unpaid","Cancelled","PendingUpgrade","PendingDowngrade","Expired","Purged"]},"FuseWebExternalCoreModelsExternalCreditSummary":{"type":"object","additionalProperties":false,"properties":{"LastUpdated":{"type":"string","description":"This information was last generated at this time","format":"date-time"},"CreditsRemaining":{"type":"integer","format":"int32"},"NextUpdating":{"type":"string","description":"This information will be updated at this time (10 minuntes after the last update)","format":"date-time"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Tenant/GetBillingState":{"get":{"tags":["Tenant"],"summary":"Produce a summary of the billing state of a given FuseSign tenant.","description":"Produces the summary of the billing state for this tenant. The requesting user must be a FuseSign user to access this information. A credit consumed summary is also produced","operationId":"ExternalApiExternalHandlersFeaturesTenantGetBillingStateGetBillingStateEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuseWebExternalCoreModelsExternalBillingStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Produce a summary of the default configuration of a given FuseSign tenant.

> Produces the summary of the business configuration for this tenant. The requesting user must be a FuseSign user to access this information.

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"FuseWebExternalCoreModelsBundleDefaultConfiguration":{"type":"object","additionalProperties":false,"properties":{"DefaultBundleReminder":{"description":"Default reminder setting","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleReminderMode"}]},"DefaultOverdueBundleReminder":{"description":"Default overdue reminder setting","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode"}]},"DefaultViewMode":{"description":"The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleViewMode"}]},"EnabledMixedViewMode":{"type":"boolean","description":"Mixed mode (customers can have different view modes) Enabled. If a business has this mode enabled it is suggested to not pass view mode on bundles. The system will select the highest mode for each recipient by default"},"DefaultRecipientReceiveMode":{"description":"Default recipient receive mode setting","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsRecipientReceiveMode"}]},"DefaultCountryCode":{"type":"string","description":"Default country code","nullable":true},"EnableDefaultDueDate":{"type":"boolean","description":"Automatically apply a default due date span when a bundle is created. Default is 30 days and can be modified via DefaultDueDateSpan."},"DefaultDueDateSpan":{"type":"integer","description":"Number of days into the future to set the due date for new bundles, if EnableDefaultDueDate is enabled.","format":"int32"},"DefaultSigningMode":{"description":"Default signature placement mode [Signing Placements Required if CreateAndSend and Sending]","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningMode"}]},"DefaultRejectionMode":{"description":"Default bundle rejection mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsRejectionMode"}]},"DefaultSMSNotificationMode":{"description":"Default SMS Notification Mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSmsNotificationMode"}]}}},"FuseWebSharedObjectsFuseSignEnumsBundleReminderMode":{"type":"string","description":"","enum":["DontRemind","DayBeforeDue","OnDueDate"]},"FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode":{"type":"string","description":"","enum":["DontRemind","Weekly"]},"FuseWebSharedObjectsFuseSignEnumsBundleViewMode":{"type":"string","description":"","enum":["SmsToSign","SmsToView","EmailToSign","Unauthenticated","EmailToView","Mixed"]},"FuseWebSharedObjectsFuseSignEnumsRecipientReceiveMode":{"type":"string","description":"","enum":["EmailWithAttachments","EmailWithLinkOnly"]},"FuseWebSharedObjectsFuseSignEnumsSigningMode":{"type":"string","description":"","enum":["SignWhole","SignPlacements"]},"FuseWebSharedObjectsFuseSignEnumsRejectionMode":{"type":"string","description":"","enum":["RejectDocumentAllowBundleFinalisation","RejectEntireBundle"]},"FuseWebSharedObjectsFuseSignEnumsSmsNotificationMode":{"type":"string","description":"","enum":["Off","On","Disabled"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Tenant/GetDefaultSettings":{"get":{"tags":["Tenant"],"summary":"Produce a summary of the default configuration of a given FuseSign tenant.","description":"Produces the summary of the business configuration for this tenant. The requesting user must be a FuseSign user to access this information.","operationId":"ExternalApiExternalHandlersFeaturesTenantGetDefaultSettingsGetDefaultSettingsEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuseWebExternalCoreModelsBundleDefaultConfiguration"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

{% openapi src="/files/hTqA8RToM8RDh0Xx7Sd9" path="/api/Tenant/GetTeams" method="get" %}
[external-openapi3.yaml](https://2334922495-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqZtImBHbaWiDQmQ3uJAL%2Fuploads%2FU2fwQ87MXQmitdbIn18v%2Fexternal-openapi3.yaml?alt=media\&token=5734e26b-0574-4d7d-b128-0328a81eeade)
{% endopenapi %}