> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # API Categories This API is separated into major categories. Each category covers one or more resources and the resources' methods. | Category | Summary | | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Accounts](/docs/rooms-api/reference/accounts) | Information about accounts. | | [Documents](/docs/rooms-api/reference/documents) | Information about documents. | | [ESignPermissionProfiles](/docs/rooms-api/reference/esignpermissionprofiles) | A permission profile is a standard set of user permissions that you can apply to individual users or the users in a group. This functionality makes it easier to manage permissions for a large number of users. | | [Fields](/docs/rooms-api/reference/fields) | This section shows you how to retrieve a specific field set. This is a set of fields that can appear on a room's **Details** tab. | | [Forms](/docs/rooms-api/reference/forms) | The Forms feature of Docusign Rooms for Real Estate enables provides access to standard industry association forms that you can add to rooms. **Note:** Forms is not a default feature and is currently only available in Rooms for Real Estate. To request access to Forms, contact your Docusign Account Manager. | | [GlobalResources](/docs/rooms-api/reference/globalresources) | The Global Resources category organizes resource that are used throughout the Rooms API. You typically use these resources when you create or update a room, region, office, or user. | | [Offices](/docs/rooms-api/reference/offices) | You can use the API to manage offices in your Rooms account. | | [Regions](/docs/rooms-api/reference/regions) | You can use the API to manage regions associated with your Rooms account. | | [Roles](/docs/rooms-api/reference/roles) | The Roles resource enables you to easily manage user permissions. | | [Rooms](/docs/rooms-api/reference/rooms) | This section shows you how to create and mange rooms. In Rooms for Real Estate, a room is a collaborative digital space corresponding to a specific property. In Rooms for Mortgages, a room corresponds to a specific loan. | | [RoomTemplates](/docs/rooms-api/reference/roomtemplates) | Room templates enable your company to standardize the new rooms that users create. | | [TaskLists](/docs/rooms-api/reference/tasklists) | The TaskLists resource helps you keep track of the documents and activities you must complete before you can close a room. | | [Users](/docs/rooms-api/reference/users) | The Users resource provides methods that enable you to add, update, delete, and manage users. | ## Docs - [Accounts Category](https://developers.docusign.com/docs/rooms-api/reference/accounts.md) - [Accounts Resource](https://developers.docusign.com/docs/rooms-api/reference/accounts/accounts.md) - [Documents Category](https://developers.docusign.com/docs/rooms-api/reference/documents.md) - [Documents Resource](https://developers.docusign.com/docs/rooms-api/reference/documents/documents.md) - [ESignPermissionProfiles Category](https://developers.docusign.com/docs/rooms-api/reference/esignpermissionprofiles.md) - [ESignPermissionProfiles Resource](https://developers.docusign.com/docs/rooms-api/reference/esignpermissionprofiles/esignpermissionprofiles.md) - [Fields Category](https://developers.docusign.com/docs/rooms-api/reference/fields.md) - [Fields Resource](https://developers.docusign.com/docs/rooms-api/reference/fields/fields.md) - [Forms Category](https://developers.docusign.com/docs/rooms-api/reference/forms.md) - [ExternalFormFillSessions Resource](https://developers.docusign.com/docs/rooms-api/reference/forms/externalformfillsessions.md) - [FormDetails Resource](https://developers.docusign.com/docs/rooms-api/reference/forms/formdetails.md) - [FormGroups Resource](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups.md) - [FormLibraries Resource](https://developers.docusign.com/docs/rooms-api/reference/forms/formlibraries.md) - [FormProviders Resource](https://developers.docusign.com/docs/rooms-api/reference/forms/formproviders.md) - [GlobalResources Category](https://developers.docusign.com/docs/rooms-api/reference/globalresources.md) - [ClosingStatuses Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/closingstatuses.md) - [ContactSides Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/contactsides.md) - [Countries Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/countries.md) - [Currencies Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/currencies.md) - [FinancingTypes Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/financingtypes.md) - [OriginsOfLeads Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/originsofleads.md) - [PropertyTypes Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/propertytypes.md) - [RoomContactTypes Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/roomcontacttypes.md) - [SellerDecisionTypes Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/sellerdecisiontypes.md) - [SpecialCircumstanceTypes Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/specialcircumstancetypes.md) - [States Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/states.md) - [TaskDateTypes Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/taskdatetypes.md) - [TaskResponsibilityTypes Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/taskresponsibilitytypes.md) - [TaskStatuses Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/taskstatuses.md) - [TimeZones Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/timezones.md) - [TransactionSides Resource](https://developers.docusign.com/docs/rooms-api/reference/globalresources/transactionsides.md) - [Offices Category](https://developers.docusign.com/docs/rooms-api/reference/offices.md) - [Offices Resource](https://developers.docusign.com/docs/rooms-api/reference/offices/offices.md) - [Regions Category](https://developers.docusign.com/docs/rooms-api/reference/regions.md) - [Regions Resource](https://developers.docusign.com/docs/rooms-api/reference/regions/regions.md) - [Roles Category](https://developers.docusign.com/docs/rooms-api/reference/roles.md) - [Roles Resource](https://developers.docusign.com/docs/rooms-api/reference/roles/roles.md) - [Rooms Category](https://developers.docusign.com/docs/rooms-api/reference/rooms.md) - [RoomFolders Resource](https://developers.docusign.com/docs/rooms-api/reference/rooms/roomfolders.md) - [Rooms Resource](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms.md) - [RoomTemplates Category](https://developers.docusign.com/docs/rooms-api/reference/roomtemplates.md) - [RoomTemplates Resource](https://developers.docusign.com/docs/rooms-api/reference/roomtemplates/roomtemplates.md) - [TaskLists Category](https://developers.docusign.com/docs/rooms-api/reference/tasklists.md) - [TaskLists Resource](https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklists.md) - [TaskListTemplates Resource](https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklisttemplates.md) - [Users Category](https://developers.docusign.com/docs/rooms-api/reference/users.md) - [Users Resource](https://developers.docusign.com/docs/rooms-api/reference/users/users.md) ## API Docs - API Reference > Accounts > Accounts [Get account information](https://developers.docusign.com/docs/rooms-api/reference/accounts/accounts/getaccountinformation.md) - API Reference > Documents > Documents [Grant user access to document](https://developers.docusign.com/docs/rooms-api/reference/documents/documents/createdocumentuser.md) - API Reference > Documents > Documents [Delete document](https://developers.docusign.com/docs/rooms-api/reference/documents/documents/deletedocument.md) - API Reference > Documents > Documents [Get document](https://developers.docusign.com/docs/rooms-api/reference/documents/documents/getdocument.md) - API Reference > ESignPermissionProfiles > ESignPermissionProfiles [Get eSignature permission profiles](https://developers.docusign.com/docs/rooms-api/reference/esignpermissionprofiles/esignpermissionprofiles/getesignpermissionprofiles.md) - API Reference > Fields > Fields [Get field set](https://developers.docusign.com/docs/rooms-api/reference/fields/fields/getfieldset.md) - API Reference > Forms > ExternalFormFillSessions [Create external form fill session](https://developers.docusign.com/docs/rooms-api/reference/forms/externalformfillsessions/createexternalformfillsession.md) - API Reference > Forms > FormDetails [Get form details](https://developers.docusign.com/docs/rooms-api/reference/forms/formdetails/getformdetails.md) - API Reference > Forms > FormGroups [Assign form to form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/assignformgroupform.md) - API Reference > Forms > FormGroups [Create form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/createformgroup.md) - API Reference > Forms > FormGroups [Delete form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/deleteformgroup.md) - API Reference > Forms > FormGroups [Get form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/getformgroup.md) - API Reference > Forms > FormGroups [Get forms of form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/getformgroupforms.md) - API Reference > Forms > FormGroups [Get form groups](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/getformgroups.md) - API Reference > Forms > FormGroups [Grant office access to form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/grantofficeaccesstoformgroup.md) - API Reference > Forms > FormGroups [Remove form from form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/removeformgroupform.md) - API Reference > Forms > FormGroups [Rename form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/renameformgroup.md) - API Reference > Forms > FormGroups [Revoke office's access to form group](https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/revokeofficeaccessfromformgroup.md) - API Reference > Forms > FormLibraries [Get form libraries](https://developers.docusign.com/docs/rooms-api/reference/forms/formlibraries/getformlibraries.md) - API Reference > Forms > FormLibraries [Get forms in form library](https://developers.docusign.com/docs/rooms-api/reference/forms/formlibraries/getformlibraryforms.md) - API Reference > Forms > FormProviders [Get associations by provider](https://developers.docusign.com/docs/rooms-api/reference/forms/formproviders/getformproviderassociations.md) - API Reference > GlobalResources > ClosingStatuses [Get closing statuses](https://developers.docusign.com/docs/rooms-api/reference/globalresources/closingstatuses/getclosingstatuses.md) - API Reference > GlobalResources > ContactSides [Get contact sides](https://developers.docusign.com/docs/rooms-api/reference/globalresources/contactsides/getcontactsides.md) - API Reference > GlobalResources > Countries [Get countries](https://developers.docusign.com/docs/rooms-api/reference/globalresources/countries/getcountries.md) - API Reference > GlobalResources > Currencies [Get valid currencies](https://developers.docusign.com/docs/rooms-api/reference/globalresources/currencies/getcurrencies.md) - API Reference > GlobalResources > FinancingTypes [Get financing types](https://developers.docusign.com/docs/rooms-api/reference/globalresources/financingtypes/getfinancingtypes.md) - API Reference > GlobalResources > OriginsOfLeads [Get origins of leads](https://developers.docusign.com/docs/rooms-api/reference/globalresources/originsofleads/getoriginsofleads.md) - API Reference > GlobalResources > PropertyTypes [Get property types](https://developers.docusign.com/docs/rooms-api/reference/globalresources/propertytypes/getpropertytypes.md) - API Reference > GlobalResources > RoomContactTypes [Get room contact types](https://developers.docusign.com/docs/rooms-api/reference/globalresources/roomcontacttypes/getroomcontacttypes.md) - API Reference > GlobalResources > SellerDecisionTypes [Get seller decision types](https://developers.docusign.com/docs/rooms-api/reference/globalresources/sellerdecisiontypes/getsellerdecisiontypes.md) - API Reference > GlobalResources > SpecialCircumstanceTypes [Get special circumstance types](https://developers.docusign.com/docs/rooms-api/reference/globalresources/specialcircumstancetypes/getspecialcircumstancetypes.md) - API Reference > GlobalResources > States [Get states](https://developers.docusign.com/docs/rooms-api/reference/globalresources/states/getstates.md) - API Reference > GlobalResources > TaskDateTypes [Get task date types](https://developers.docusign.com/docs/rooms-api/reference/globalresources/taskdatetypes/gettaskdatetypes.md) - API Reference > GlobalResources > TaskResponsibilityTypes [Get task responsibility types](https://developers.docusign.com/docs/rooms-api/reference/globalresources/taskresponsibilitytypes/gettaskresponsibilitytypes.md) - API Reference > GlobalResources > TaskStatuses [List valid task statuses](https://developers.docusign.com/docs/rooms-api/reference/globalresources/taskstatuses/gettaskstatuses.md) - API Reference > GlobalResources > TimeZones [Get time zones](https://developers.docusign.com/docs/rooms-api/reference/globalresources/timezones/gettimezones.md) - API Reference > GlobalResources > TransactionSides [Get transaction sides](https://developers.docusign.com/docs/rooms-api/reference/globalresources/transactionsides/gettransactionsides.md) - API Reference > Offices > Offices [Create office](https://developers.docusign.com/docs/rooms-api/reference/offices/offices/createoffice.md) - API Reference > Offices > Offices [Delete office](https://developers.docusign.com/docs/rooms-api/reference/offices/offices/deleteoffice.md) - API Reference > Offices > Offices [Get office](https://developers.docusign.com/docs/rooms-api/reference/offices/offices/getoffice.md) - API Reference > Offices > Offices [Get offices](https://developers.docusign.com/docs/rooms-api/reference/offices/offices/getoffices.md) - API Reference > Offices > Offices [Get office reference counts](https://developers.docusign.com/docs/rooms-api/reference/offices/offices/getreferencecounts.md) - API Reference > Regions > Regions [Create region](https://developers.docusign.com/docs/rooms-api/reference/regions/regions/createregion.md) - API Reference > Regions > Regions [Delete region](https://developers.docusign.com/docs/rooms-api/reference/regions/regions/deleteregion.md) - API Reference > Regions > Regions [Get region](https://developers.docusign.com/docs/rooms-api/reference/regions/regions/getregion.md) - API Reference > Regions > Regions [Get region reference counts](https://developers.docusign.com/docs/rooms-api/reference/regions/regions/getregionreferencecounts.md) - API Reference > Regions > Regions [Get regions](https://developers.docusign.com/docs/rooms-api/reference/regions/regions/getregions.md) - API Reference > Roles > Roles [Create role](https://developers.docusign.com/docs/rooms-api/reference/roles/roles/createrole.md) - API Reference > Roles > Roles [Delete role](https://developers.docusign.com/docs/rooms-api/reference/roles/roles/deleterole.md) - API Reference > Roles > Roles [Get role](https://developers.docusign.com/docs/rooms-api/reference/roles/roles/getrole.md) - API Reference > Roles > Roles [Get roles](https://developers.docusign.com/docs/rooms-api/reference/roles/roles/getroles.md) - API Reference > Roles > Roles [Update role](https://developers.docusign.com/docs/rooms-api/reference/roles/roles/updaterole.md) - API Reference > Rooms > RoomFolders [List room folders accessible to current user](https://developers.docusign.com/docs/rooms-api/reference/rooms/roomfolders/getroomfolders.md) - API Reference > Rooms > Rooms [Add document to room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/adddocumenttoroom.md) - API Reference > Rooms > Rooms [Upload contents of file as document to room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/adddocumenttoroomviafileupload.md) - API Reference > Rooms > Rooms [Add form to room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/addformtoroom.md) - API Reference > Rooms > Rooms [Create room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/createroom.md) - API Reference > Rooms > Rooms [Create envelope](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/createroomenvelope.md) - API Reference > Rooms > Rooms [Delete room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/deleteroom.md) - API Reference > Rooms > Rooms [Get assignable room-level roles in v6](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/getassignableroles.md) - API Reference > Rooms > Rooms [List documents in room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/getdocuments.md) - API Reference > Rooms > Rooms [Get room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/getroom.md) - API Reference > Rooms > Rooms [Get room's field data](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/getroomfielddata.md) - API Reference > Rooms > Rooms [Get field set for room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/getroomfieldset.md) - API Reference > Rooms > Rooms [List rooms](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/getrooms.md) - API Reference > Rooms > Rooms [Get room's users](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/getroomusers.md) - API Reference > Rooms > Rooms [Invite user to room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/inviteuser.md) - API Reference > Rooms > Rooms [Update room user](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/putroomuser.md) - API Reference > Rooms > Rooms [Restore user's access to room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/restoreroomuseraccess.md) - API Reference > Rooms > Rooms [Revoke user's access to room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/revokeroomuseraccess.md) - API Reference > Rooms > Rooms [Update picture for room](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/updatepicture.md) - API Reference > Rooms > Rooms [Update room's field data](https://developers.docusign.com/docs/rooms-api/reference/rooms/rooms/updateroomfielddata.md) - API Reference > RoomTemplates > RoomTemplates [Get room templates](https://developers.docusign.com/docs/rooms-api/reference/roomtemplates/roomtemplates/getroomtemplates.md) - API Reference > TaskLists > TaskLists [Apply task list to room](https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklists/createtasklist.md) - API Reference > TaskLists > TaskLists [Delete task list from room](https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklists/deletetasklist.md) - API Reference > TaskLists > TaskLists [Get task lists for room](https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklists/gettasklists.md) - API Reference > TaskLists > TaskListTemplates [Get task list templates](https://developers.docusign.com/docs/rooms-api/reference/tasklists/tasklisttemplates/gettasklisttemplates.md) - API Reference > Users > Users [Add user to office](https://developers.docusign.com/docs/rooms-api/reference/users/users/addusertooffice.md) - API Reference > Users > Users [Add user to region](https://developers.docusign.com/docs/rooms-api/reference/users/users/addusertoregion.md) - API Reference > Users > Users [Get user](https://developers.docusign.com/docs/rooms-api/reference/users/users/getuser.md) - API Reference > Users > Users [List users](https://developers.docusign.com/docs/rooms-api/reference/users/users/getusers.md) - API Reference > Users > Users [Invite user to company account](https://developers.docusign.com/docs/rooms-api/reference/users/users/inviteuser.md) - API Reference > Users > Users [Lock user's account](https://developers.docusign.com/docs/rooms-api/reference/users/users/lockuser.md) - API Reference > Users > Users [Reinvite user to join company account](https://developers.docusign.com/docs/rooms-api/reference/users/users/reinviteuser.md) - API Reference > Users > Users [Remove user from company account](https://developers.docusign.com/docs/rooms-api/reference/users/users/removeuser.md) - API Reference > Users > Users [Remove user from office](https://developers.docusign.com/docs/rooms-api/reference/users/users/removeuserfromoffice.md) - API Reference > Users > Users [Remove user from region](https://developers.docusign.com/docs/rooms-api/reference/users/users/removeuserfromregion.md) - API Reference > Users > Users [Unlock user's account](https://developers.docusign.com/docs/rooms-api/reference/users/users/unlockuser.md) - API Reference > Users > Users [Update user's default office](https://developers.docusign.com/docs/rooms-api/reference/users/users/updateuser.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.docusign.com/openapi.json) - [OpenAPI YAML](https://developers.docusign.com/openapi.yaml)