# Stonal Public API

> Public API documentation for Stonal: asset management, document storage, user management, webhooks, and legacy endpoints.

Base URL: https://docs.stonal.io


## Guides

- [Assets hierarchy](https://docs.stonal.io/md/assets/hierarchy)
- [Authenticating users](https://docs.stonal.io/md/users/authenticating-users)
- [Creating a user](https://docs.stonal.io/md/users/legacy/create-a-user)
- [Getting Started](https://docs.stonal.io)
- [Ingesting data](https://docs.stonal.io/md/assets/ingest)
- [Managing documents](https://docs.stonal.io/md/documents)
- [Personal Access Token (Recommended)](https://docs.stonal.io/md/auth/pat)
- [Authenticating](https://docs.stonal.io/md/auth)
- [Creating a user](https://docs.stonal.io/md/users/create-a-user)
- [Modifying a user](https://docs.stonal.io/md/users/legacy/modify-a-user)
- [OpenID Connect](https://docs.stonal.io/md/auth/openid)
- [Upload a file](https://docs.stonal.io/md/documents/upload-a-file)
- [Deleting a user](https://docs.stonal.io/md/users/legacy/delete-a-user)
- [Modifying a user](https://docs.stonal.io/md/users/modify-a-user)
- [Search Documents](https://docs.stonal.io/md/documents/search-documents)
- [Searching data](https://docs.stonal.io/md/assets/search)
- [Deleting a user](https://docs.stonal.io/md/users/delete-a-user)
- [Resynchronizing users](https://docs.stonal.io/md/users/legacy/resync-users)
- [Retrieve documentations for an asset](https://docs.stonal.io/md/documents/get-documentations)
- [Upload a file (Python)](https://docs.stonal.io/md/documents/upload-a-file-python)
- [Resynchronizing users](https://docs.stonal.io/md/users/resync-users)
- [Retrieve documentation templates](https://docs.stonal.io/md/documents/get-templates)
- [Create a Contract](https://docs.stonal.io/md/contracts/creation)
- [Create a Stakeholder](https://docs.stonal.io/md/stakeholders/creation)
- [Delete a Stakeholder](https://docs.stonal.io/md/stakeholders/delete)
- [Managing assets](https://docs.stonal.io/md/assets)
- [Managing Contracts](https://docs.stonal.io/md/contracts)
- [Managing Stakeholders](https://docs.stonal.io/md/stakeholders)
- [Managing users](https://docs.stonal.io/md/users)
- [Managing users](https://docs.stonal.io/md/users/legacy)
- [Receiving live updates](https://docs.stonal.io/md/webhooks)
- [Search Contracts](https://docs.stonal.io/md/contracts/search)
- [Search Stakeholders](https://docs.stonal.io/md/stakeholders/search)
- [Server implementation](https://docs.stonal.io/md/webhooks/server)
- [Testing webhooks](https://docs.stonal.io/md/webhooks/sample)
- [Update a Contract (partial)](https://docs.stonal.io/md/contracts/update)
- [Update a Stakeholder (full resource)](https://docs.stonal.io/md/stakeholders/updatePut)
- [Update a Stakeholder (partial)](https://docs.stonal.io/md/stakeholders/updatePatch)

## Documents API

- [Document Storage API - Public Endpoints](https://docs.stonal.io/api/documents/document-storage-api-public-endpoints): Public API endpoints for document storage service
- [Download a file](https://docs.stonal.io/api/documents/download-file): Downloads a file by document identifier for a specific organization. The file will be returned as a binary stream.
- [Get documentations for an asset](https://docs.stonal.io/api/documents/get-documentations-for-asset): Retrieves all documentation entries associated with a specific asset identified by either assetUid or externalId
- [Get documentation template tree](https://docs.stonal.io/api/documents/get-template): Returns the complete folder tree for a documentation template.
- [List documentation templates](https://docs.stonal.io/api/documents/get-templates): Returns the documentation templates available for an organization. A language parameter lets clients select the preferred locale for the name field.
- [Rename a document](https://docs.stonal.io/api/documents/rename-document): Changes the name of a document. This endpoint is available for public use.
- [Search for documents](https://docs.stonal.io/api/documents/search): Searches for documents based on provided filters with pagination and sorting options. This endpoint is available for public use.
- [showFileContentDefault](https://docs.stonal.io/api/documents/show-file-content-default): showFileContentDefault
- [Show file content](https://docs.stonal.io/api/documents/show-file-content): Show a file by its identifier. The file is identified by the document identifier.
- [Add or remove documentation tags on documents](https://docs.stonal.io/api/documents/update-document-documentation-tags): Updates documentation tags on documents. Each item carries its asset scope in the request body, missing tags are created before assignment and the whole request is processed in one transaction.
- [Upload a file](https://docs.stonal.io/api/documents/upload-file): Uploads a file with a JSON manifest. The manifest provides context for the upload, such as asset, documentation, linked assets, tags, properties, and destination folder.

## Documents API – Schemas

- [Asset](https://docs.stonal.io/api/documents/schemas/asset): Information concerning the location in which the file will be uploaded (BUILDING_GROUP, BUILDING)
- [ClassificationReferenceDocumentView](https://docs.stonal.io/api/documents/schemas/classificationreferencedocumentview): Information about a document used for classification
- [Documentation](https://docs.stonal.io/api/documents/schemas/documentation): Information concerning the documentation the file will be uploaded
- [DocumentationResponseView](https://docs.stonal.io/api/documents/schemas/documentationresponseview): Detailed information about a documentation entry
- [DocumentationSimplifiedView](https://docs.stonal.io/api/documents/schemas/documentationsimplifiedview): Response containing a set of documentation entries for an asset
- [DocumentFolderView](https://docs.stonal.io/api/documents/schemas/documentfolderview): Information about a document folder
- [DocumentLocationView](https://docs.stonal.io/api/documents/schemas/documentlocationview): Location information of a document within a documentation structure
- [DocumentPathView](https://docs.stonal.io/api/documents/schemas/documentpathview): Information about a node in the document path
- [DocumentReferenceView](https://docs.stonal.io/api/documents/schemas/documentreferenceview): Reference to an entity related to the document
- [DocumentSearchFilter](https://docs.stonal.io/api/documents/schemas/documentsearchfilter): Document search filters
- [DocumentTemplateFolderView](https://docs.stonal.io/api/documents/schemas/documenttemplatefolderview): Information about a document template folder
- [DocumentView](https://docs.stonal.io/api/documents/schemas/documentview): Comprehensive view of a document with all its metadata and references
- [EmbeddedDocumentClassView](https://docs.stonal.io/api/documents/schemas/embeddeddocumentclassview): Information about the validated document class
- [FileResourceView](https://docs.stonal.io/api/documents/schemas/fileresourceview): Information about the file resource associated with a document
- [FileUploadedResponse](https://docs.stonal.io/api/documents/schemas/fileuploadedresponse): Response returned after successfully uploading a file
- [Folder](https://docs.stonal.io/api/documents/schemas/folder): Folder information where the file should be stored
- [FolderResponseView](https://docs.stonal.io/api/documents/schemas/folderresponseview): Folder structure containing documentation files
- [JsonNode](https://docs.stonal.io/api/documents/schemas/jsonnode)
- [LinkedAssetReference](https://docs.stonal.io/api/documents/schemas/linkedassetreference): Reference to a linked asset
- [LinkedAssetView](https://docs.stonal.io/api/documents/schemas/linkedassetview): Information about a linked asset
- [LocalisedNameView](https://docs.stonal.io/api/documents/schemas/localisednameview): Localized name information with language code
- [ManifestView](https://docs.stonal.io/api/documents/schemas/manifestview): Manifest containing contextual details about the file upload. All fields are optional.
- [Pageable](https://docs.stonal.io/api/documents/schemas/pageable)
- [PageResultOfDocumentView](https://docs.stonal.io/api/documents/schemas/pageresultofdocumentview): Paged list of documents
- [PredictedDocumentClassView](https://docs.stonal.io/api/documents/schemas/predicteddocumentclassview): Information about the document class predicted by AI
- [PredictedFolderView](https://docs.stonal.io/api/documents/schemas/predictedfolderview): Information about the folder predicted by AI
- [SearchedDocumentClass](https://docs.stonal.io/api/documents/schemas/searcheddocumentclass)
- [SearchedFolder](https://docs.stonal.io/api/documents/schemas/searchedfolder)
- [Sort](https://docs.stonal.io/api/documents/schemas/sort)
- [TagsView](https://docs.stonal.io/api/documents/schemas/tagsview): Tags applied to the uploaded document
- [TagView](https://docs.stonal.io/api/documents/schemas/tagview): Represents a tag assigned to a documentation.
- [TemplateDetail](https://docs.stonal.io/api/documents/schemas/templatedetail): Documentation template description with its metadata and folders
- [TemplateDetailResponse](https://docs.stonal.io/api/documents/schemas/templatedetailresponse): Response containing a documentation template with its folder tree
- [TemplateFolderDetail](https://docs.stonal.io/api/documents/schemas/templatefolderdetail): Folder within a documentation template
- [TemplateFolderDocumentClass](https://docs.stonal.io/api/documents/schemas/templatefolderdocumentclass): Document class linked to a documentation template folder
- [TemplateListItem](https://docs.stonal.io/api/documents/schemas/templatelistitem): Documentation template entry exposed in the public API
- [TemplatesListResponse](https://docs.stonal.io/api/documents/schemas/templateslistresponse): Response containing documentation templates for an organization
- [TenantView](https://docs.stonal.io/api/documents/schemas/tenantview): Represents a tenant linked to a document.
- [UpdateDocumentDocumentationTagsItemRequest](https://docs.stonal.io/api/documents/schemas/updatedocumentdocumentationtagsitemrequest): Tag update instruction scoped to a document and a documentation
- [UpdateDocumentDocumentationTagsRequest](https://docs.stonal.io/api/documents/schemas/updatedocumentdocumentationtagsrequest): Request to add or remove documentation tags on documents across multiple documentations
- [UploadRequest](https://docs.stonal.io/api/documents/schemas/uploadrequest): Multipart form-data with a file and a JSON manifest

## Users API

- [Users Service API](https://docs.stonal.io/api/users/users-service-api): Public API endpoints for the users service
- [Create a group](https://docs.stonal.io/api/users/create-group): > [!important]
- [Create or update permission](https://docs.stonal.io/api/users/create-permission): > [!important]
- [Create user](https://docs.stonal.io/api/users/create-user): > [!important]
- [Delete a group](https://docs.stonal.io/api/users/delete-group): > [!important]
- [Delete a permission](https://docs.stonal.io/api/users/delete-permission): > [!important]
- [Delete user](https://docs.stonal.io/api/users/delete-user): > [!important]
- [Get groups](https://docs.stonal.io/api/users/get-groups): > [!important]
- [Get permissions](https://docs.stonal.io/api/users/get-permissions): > [!important]
- [Get user by UID](https://docs.stonal.io/api/users/get-user-by-uid): > [!important]
- [Get paginated users](https://docs.stonal.io/api/users/get-users-paginated): > [!important]
- [Update a group](https://docs.stonal.io/api/users/update-group): > [!important]
- [Update user](https://docs.stonal.io/api/users/update-user): > [!important]

## Users API – Schemas

- [GroupPageResult](https://docs.stonal.io/api/users/schemas/grouppageresult)
- [GroupRequest](https://docs.stonal.io/api/users/schemas/grouprequest)
- [GroupResult](https://docs.stonal.io/api/users/schemas/groupresult)
- [PermissionChildrenResult](https://docs.stonal.io/api/users/schemas/permissionchildrenresult)
- [PermissionMetadata](https://docs.stonal.io/api/users/schemas/permissionmetadata)
- [PermissionMetadataLogo](https://docs.stonal.io/api/users/schemas/permissionmetadatalogo)
- [PermissionPageResult](https://docs.stonal.io/api/users/schemas/permissionpageresult)
- [PermissionResult](https://docs.stonal.io/api/users/schemas/permissionresult)
- [PermissionUsersResult](https://docs.stonal.io/api/users/schemas/permissionusersresult)
- [ReportThematic](https://docs.stonal.io/api/users/schemas/reportthematic)
- [UpsertPermissionReportRequest](https://docs.stonal.io/api/users/schemas/upsertpermissionreportrequest)
- [UpsertPermissionRequest](https://docs.stonal.io/api/users/schemas/upsertpermissionrequest)
- [UpsertPermissionScopeRequest](https://docs.stonal.io/api/users/schemas/upsertpermissionscoperequest)
- [UpsertUserRequest](https://docs.stonal.io/api/users/schemas/upsertuserrequest)
- [UserGroupResult](https://docs.stonal.io/api/users/schemas/usergroupresult)
- [UserPageResult](https://docs.stonal.io/api/users/schemas/userpageresult)
- [UserPermissionParams](https://docs.stonal.io/api/users/schemas/userpermissionparams)
- [UserResult](https://docs.stonal.io/api/users/schemas/userresult)

## Assets API

- [Datalake API - Public Endpoints](https://docs.stonal.io/api/assets/datalake-api-public-endpoints): Public API endpoints for the datalake service
- [Create contracts](https://docs.stonal.io/api/assets/create-contract): Create new contracts for an organization with his stakeholders and assets linked. Requires `stonal.asset.write` permission
- [Create a selection session](https://docs.stonal.io/api/assets/create-selection-session): Creates a new selection session with selection data and context for the specified organization. Requires `stonal.asset.read` permission
- [Create stakeholder](https://docs.stonal.io/api/assets/create-stakeholder): Creates a new stakeholder (person or company) for an organization. Requires `stonal.contact.write` permission
- [Delete a contract](https://docs.stonal.io/api/assets/delete-contract): Delete a contract for an organization. Requires `stonal.asset.delete` permission. If the contract code contains URL-unsafe characters (e.g. `/` in `2021/Z5059`), it MUST be **double percent-encoded** in the path — `2021/Z5059` is sent as `2021%252FZ5059`.
- [Delete a selection session](https://docs.stonal.io/api/assets/delete-selection-session): Delete a selection session and all its data. Requires `stonal.asset.read` permission
- [Delete stakeholder](https://docs.stonal.io/api/assets/delete-stakeholder): Deletes a stakeholder by its unique identifier. Requires `stonal.contact.delete` permission
- [Get all asset types](https://docs.stonal.io/api/assets/get-all-asset-types): Get all asset types by organization
- [Get all asset properties](https://docs.stonal.io/api/assets/get-all-properties): Get all asset properties by organization
- [Get contracts](https://docs.stonal.io/api/assets/get-contracts): Filter contracts by asset and/or stakeholder. Requires `stonal.asset.read` permission
- [Get selected asset details for a selection session](https://docs.stonal.io/api/assets/get-selection-session-assets): Returns the name and level of each selected asset in the session.
- [Get the plan of the assets base view in selection session](https://docs.stonal.io/api/assets/get-selection-session-plan): Get the plan of the assets base view in selection session.
- [Get a structure in function of the selection session](https://docs.stonal.io/api/assets/get-selection-session-structure): Get a structure of the unique selection session.
- [Get a selection session](https://docs.stonal.io/api/assets/get-selection-session): Get a unique selection session with its selection data and context.
- [Get stakeholder by ID](https://docs.stonal.io/api/assets/get-stakeholder-by-uid): Retrieves a single stakeholder by its unique identifier. Requires `stonal.contacts.read` permission
- [Update a contract](https://docs.stonal.io/api/assets/patch-contract): Update a contracts for an organization with his stakeholders and assets linked. Requires `stonal.asset.write` permission
- [Save stakeholder](https://docs.stonal.io/api/assets/save-stakeholder): Creates or updates a stakeholder with a specific UID. Requires `stonal.contact.write` permission
- [Search assets](https://docs.stonal.io/api/assets/search-assets): Search assets by organization. Requires `stonal.asset.read` permission
- [Search stakeholders](https://docs.stonal.io/api/assets/search-stakeholder): Search for stakeholders with various filtering options and pagination. Requires `stonal.contacts.read` permission
- [Update stakeholder](https://docs.stonal.io/api/assets/update-stakeholder): Partially updates an existing stakeholder. Requires `stonal.contact.write` permission
- [Ingest assets](https://docs.stonal.io/api/assets/upsert-assets): Create and update assets by organization. Requires `stonal.asset.write` permission

## Assets API – Schemas

- [Asset](https://docs.stonal.io/api/assets/schemas/asset)
- [AssetBuildingStructure](https://docs.stonal.io/api/assets/schemas/assetbuildingstructure)
- [AssetIds](https://docs.stonal.io/api/assets/schemas/assetids)
- [AssetProperties](https://docs.stonal.io/api/assets/schemas/assetproperties)
- [AssetRepresentations](https://docs.stonal.io/api/assets/schemas/assetrepresentations)
- [ContractAssetView](https://docs.stonal.io/api/assets/schemas/contractassetview): Asset associated with a contract
- [ContractCreationRequest](https://docs.stonal.io/api/assets/schemas/contractcreationrequest): Request body for creating a new contract
- [ContractLinkedView](https://docs.stonal.io/api/assets/schemas/contractlinkedview)
- [ContractsGetResultResponse](https://docs.stonal.io/api/assets/schemas/contractsgetresultresponse)
- [ContractUpdateRequest](https://docs.stonal.io/api/assets/schemas/contractupdaterequest): Request body for updating a contract
- [ContractView](https://docs.stonal.io/api/assets/schemas/contractview): Contract information
- [Coordinate](https://docs.stonal.io/api/assets/schemas/coordinate)
- [CreateSelectionSessionRequest](https://docs.stonal.io/api/assets/schemas/createselectionsessionrequest): Request body for creating a selection session
- [CreateSelectionSessionResponse](https://docs.stonal.io/api/assets/schemas/createselectionsessionresponse): Response containing the created selection session UID and access URL
- [CreateStakeholderContactDetail](https://docs.stonal.io/api/assets/schemas/createstakeholdercontactdetail)
- [CreateStakeHolderRequestBody](https://docs.stonal.io/api/assets/schemas/createstakeholderrequestbody): Request body for creating a new stakeholder
- [CreateStakeHolderResponseBody](https://docs.stonal.io/api/assets/schemas/createstakeholderresponsebody): Response body for stakeholder creation
- [DeadlineView](https://docs.stonal.io/api/assets/schemas/deadlineview): A deadline in the contract
- [EffectiveDate](https://docs.stonal.io/api/assets/schemas/effectivedate)
- [EquipmentView](https://docs.stonal.io/api/assets/schemas/equipmentview): Equipment linked to a contract
- [ErrorInfo](https://docs.stonal.io/api/assets/schemas/errorinfo)
- [ExpirationDate](https://docs.stonal.io/api/assets/schemas/expirationdate)
- [GetSelectionSessionAssetsResponse](https://docs.stonal.io/api/assets/schemas/getselectionsessionassetsresponse): Response containing the details of selected assets in a selection session
- [GetSelectionSessionResponse](https://docs.stonal.io/api/assets/schemas/getselectionsessionresponse): Response for getting a selection session containing its selection data and context
- [HolderTypeNameView](https://docs.stonal.io/api/assets/schemas/holdertypenameview): Localized name information for a holder type
- [HolderTypeView](https://docs.stonal.io/api/assets/schemas/holdertypeview): Holder type information
- [ImportErrors](https://docs.stonal.io/api/assets/schemas/importerrors): Information about import errors
- [IngestAssetsFailResponse](https://docs.stonal.io/api/assets/schemas/ingestassetsfailresponse): Failure response containing error information
- [IngestAssetsIssue](https://docs.stonal.io/api/assets/schemas/ingestassetsissue): A diagnostic about how the platform handled an input row. The asset may be persisted, possibly with reduced data.
- [IngestAssetsSuccessResponse](https://docs.stonal.io/api/assets/schemas/ingestassetssuccessresponse): Response containing the list of ingested assets
- [PageRequested](https://docs.stonal.io/api/assets/schemas/pagerequested): Information about the requested page in paginated responses
- [PlanRepresentationResponseBody](https://docs.stonal.io/api/assets/schemas/planrepresentationresponsebody): Response containing SVG plan representation
- [PublicAssetResponse](https://docs.stonal.io/api/assets/schemas/publicassetresponse): Base sealed class for public asset responses
- [PublicAssetTypeNameResponse](https://docs.stonal.io/api/assets/schemas/publicassettypenameresponse): Name of the asset type
- [PublicAssetTypeResponse](https://docs.stonal.io/api/assets/schemas/publicassettyperesponse): Asset type
- [PublicAssetTypesResponse](https://docs.stonal.io/api/assets/schemas/publicassettypesresponse): List of asset types
- [PublicPropertiesResponse](https://docs.stonal.io/api/assets/schemas/publicpropertiesresponse): List of properties for an organization
- [PublicPropertyResponse](https://docs.stonal.io/api/assets/schemas/publicpropertyresponse): Property for an organization
- [SaveAssetsCommandOptions](https://docs.stonal.io/api/assets/schemas/saveassetscommandoptions)
- [SaveAssetsCommandPropertiesOptions](https://docs.stonal.io/api/assets/schemas/saveassetscommandpropertiesoptions)
- [SaveContactDetailsResponseBody](https://docs.stonal.io/api/assets/schemas/savecontactdetailsresponsebody)
- [SaveStakeHolderRequestBody](https://docs.stonal.io/api/assets/schemas/savestakeholderrequestbody): Request body of creating or updating a stakeholder with a specific UID
- [SaveStakeHolderResponseBody](https://docs.stonal.io/api/assets/schemas/savestakeholderresponsebody): Response body for save stakeholder operations
- [SearchAssetDataCondition](https://docs.stonal.io/api/assets/schemas/searchassetdatacondition): A single filter condition on property data
- [SearchAssetFieldFilter](https://docs.stonal.io/api/assets/schemas/searchassetfieldfilter):         Filter on an asset field.
- [SearchAssetFilters](https://docs.stonal.io/api/assets/schemas/searchassetfilters)
- [SearchAssetIds](https://docs.stonal.io/api/assets/schemas/searchassetids)
- [SearchAssetPaginate](https://docs.stonal.io/api/assets/schemas/searchassetpaginate)
- [SearchAssetProperties](https://docs.stonal.io/api/assets/schemas/searchassetproperties)
- [SearchAssetPropertyFilter](https://docs.stonal.io/api/assets/schemas/searchassetpropertyfilter): Filter assets by property data values
- [SearchAssetsRequest](https://docs.stonal.io/api/assets/schemas/searchassetsrequest)
- [SearchAssetsResponse](https://docs.stonal.io/api/assets/schemas/searchassetsresponse)
- [SearchPublicAsset](https://docs.stonal.io/api/assets/schemas/searchpublicasset)
- [SearchRepresentationsFilter](https://docs.stonal.io/api/assets/schemas/searchrepresentationsfilter)
- [SearchStakeHolderResponseBody](https://docs.stonal.io/api/assets/schemas/searchstakeholderresponsebody): Response body for stakeholder search operations
- [SelectionContext](https://docs.stonal.io/api/assets/schemas/selectioncontext): Context information including, among other things, base view, selectable assets, and UI options
- [SelectionContextBaseViewItem](https://docs.stonal.io/api/assets/schemas/selectioncontextbaseviewitem)
- [SelectionData](https://docs.stonal.io/api/assets/schemas/selectiondata)
- [SelectionSessionAssetDetails](https://docs.stonal.io/api/assets/schemas/selectionsessionassetdetails): Details of a selected asset including its level ancestor
- [StakeHolderContactDetailView](https://docs.stonal.io/api/assets/schemas/stakeholdercontactdetailview)
- [StakeHolderView](https://docs.stonal.io/api/assets/schemas/stakeholderview): Represents a stakeholder (person or company)
- [StructureHolderTypeName](https://docs.stonal.io/api/assets/schemas/structureholdertypename)
- [UpdateContactDetailsRequestBody](https://docs.stonal.io/api/assets/schemas/updatecontactdetailsrequestbody)
- [UpdateStakeHolderRequestBody](https://docs.stonal.io/api/assets/schemas/updatestakeholderrequestbody): Request body for partially updating an existing stakeholder (HTTP PATCH)
- [UpsertAssetsRequest](https://docs.stonal.io/api/assets/schemas/upsertassetsrequest): Request for creating or updating public asset
- [UpsertPublicAssetPrecisePropertiesDatum](https://docs.stonal.io/api/assets/schemas/upsertpublicassetprecisepropertiesdatum)

## Legacy API

- [API Consumption](https://docs.stonal.io/api/legacy/api-consumption): Welcome to Stonal® API. We provide real estate data for housing and tertiary business. The document below covers how to use our API. Let us know if you any questions.
- [1. Get token for Swagger](https://docs.stonal.io/api/legacy/1-get-token-for-swagger): 1. Get token for Swagger
- [2. API Version 1](https://docs.stonal.io/api/legacy/2-api-version-1): 2. API Version 1
- [6. API Version 5](https://docs.stonal.io/api/legacy/6-api-version-5): 6. API Version 5
- [Create a new user](https://docs.stonal.io/api/legacy/create):     Create a new user.
- [This is a soft delete of a document, the document will be marked as deleted but not removed from the storage.](https://docs.stonal.io/api/legacy/delete-document): This is a soft delete of a document, the document will be marked as deleted but not removed from the storage.
- [Delete an existing user](https://docs.stonal.io/api/legacy/delete):     Delete an existing user.
- [Get a file from a document](https://docs.stonal.io/api/legacy/download-file): Get a file from a document
- [List all authorizations available for users](https://docs.stonal.io/api/legacy/find-all-authorizations-by): List all authorizations available for users
- [List all companies available for users](https://docs.stonal.io/api/legacy/find-all-companies-by): List all companies available for users
- [List all groups available for users](https://docs.stonal.io/api/legacy/find-all-groups-by): List all groups available for users
- [List all permissions available for users](https://docs.stonal.io/api/legacy/find-all-permissions-by): List all permissions available for users
- [List all profiles available for users](https://docs.stonal.io/api/legacy/find-all-profiles-by): List all profiles available for users
- [Get a user by its id](https://docs.stonal.io/api/legacy/find-by-organization-code-and-id): Get a user by its id
- [Search for documents](https://docs.stonal.io/api/legacy/find-by): Search for documents
- [Get an access token to use for Swagger UI](https://docs.stonal.io/api/legacy/get-access-token): Get an access token to use for Swagger UI
- [Search users](https://docs.stonal.io/api/legacy/search-user-on-organization):     Search users by various filters.
- [Update an existing user](https://docs.stonal.io/api/legacy/update):     Update an existing user.
- [Upload documents](https://docs.stonal.io/api/legacy/upload-file): Upload documents
- [Validate documents classification](https://docs.stonal.io/api/legacy/validate-documents-classification): Validate documents classification

## Legacy API – Schemas

- [AccessToken](https://docs.stonal.io/api/legacy/schemas/accesstoken)
- [AssetAuthorization](https://docs.stonal.io/api/legacy/schemas/assetauthorization)
- [Authorization](https://docs.stonal.io/api/legacy/schemas/authorization)
- [AuthorizationView](https://docs.stonal.io/api/legacy/schemas/authorizationview)
- [CreateUserRequest](https://docs.stonal.io/api/legacy/schemas/createuserrequest)
- [GroupView](https://docs.stonal.io/api/legacy/schemas/groupview)
- [LegacyPageable](https://docs.stonal.io/api/legacy/schemas/legacypageable)
- [LegacyPageResultAuthorizationView](https://docs.stonal.io/api/legacy/schemas/legacypageresultauthorizationview)
- [LegacyPageResultSearchUser](https://docs.stonal.io/api/legacy/schemas/legacypageresultsearchuser)
- [LegacyPageResultString](https://docs.stonal.io/api/legacy/schemas/legacypageresultstring)
- [Pageable](https://docs.stonal.io/api/legacy/schemas/pageable)
- [PageResultPermissionView](https://docs.stonal.io/api/legacy/schemas/pageresultpermissionview)
- [PermissionView](https://docs.stonal.io/api/legacy/schemas/permissionview)
- [RemoteDocumentClassView](https://docs.stonal.io/api/legacy/schemas/remotedocumentclassview)
- [RemoteDocumentFolderView](https://docs.stonal.io/api/legacy/schemas/remotedocumentfolderview)
- [RemoteDocumentReferenceView](https://docs.stonal.io/api/legacy/schemas/remotedocumentreferenceview)
- [RemoteDocumentSearchFilters](https://docs.stonal.io/api/legacy/schemas/remotedocumentsearchfilters)
- [RemoteDocumentView](https://docs.stonal.io/api/legacy/schemas/remotedocumentview)
- [RemoteFileResourceView](https://docs.stonal.io/api/legacy/schemas/remotefileresourceview)
- [RemoteLocalisedNameView](https://docs.stonal.io/api/legacy/schemas/remotelocalisednameview)
- [RemotePredictedDocumentClassView](https://docs.stonal.io/api/legacy/schemas/remotepredicteddocumentclassview)
- [RemotePredictedFolderView](https://docs.stonal.io/api/legacy/schemas/remotepredictedfolderview)
- [RemoteRentedUnitView](https://docs.stonal.io/api/legacy/schemas/remoterentedunitview)
- [RemoteSearchedDocumentClass](https://docs.stonal.io/api/legacy/schemas/remotesearcheddocumentclass)
- [RemoteTagView](https://docs.stonal.io/api/legacy/schemas/remotetagview)
- [RemoteTenantView](https://docs.stonal.io/api/legacy/schemas/remotetenantview)
- [RemoteValidateDocumentClassificationAndFolderView](https://docs.stonal.io/api/legacy/schemas/remotevalidatedocumentclassificationandfolderview)
- [SearchUser](https://docs.stonal.io/api/legacy/schemas/searchuser)
- [SearchUserRequest](https://docs.stonal.io/api/legacy/schemas/searchuserrequest)
- [SimpleMessage](https://docs.stonal.io/api/legacy/schemas/simplemessage)
- [Sort](https://docs.stonal.io/api/legacy/schemas/sort)
- [UpdateUserRequest](https://docs.stonal.io/api/legacy/schemas/updateuserrequest)
- [User](https://docs.stonal.io/api/legacy/schemas/user)

## Webhooks API

- [Change Events Webhooks format](https://docs.stonal.io/api/webhooks/change-events-webhooks-format): Webhooks format for change events in the stonal stack
- [Receive document change events](https://docs.stonal.io/api/webhooks/receive-document-change-event): Endpoint for receiving document change events from the stonal platform

## Webhooks API – Schemas

- [DocChangeMessage](https://docs.stonal.io/api/webhooks/schemas/docchangemessage)
- [DocumentContent](https://docs.stonal.io/api/webhooks/schemas/documentcontent)
- [EventType](https://docs.stonal.io/api/webhooks/schemas/eventtype): The type of event
- [OperationType](https://docs.stonal.io/api/webhooks/schemas/operationtype): The type of operation