DocuSign Rooms API - v2
An API for an integrator to access the features of DocuSign Rooms
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
An API for an integrator to access the features of DocuSign Rooms
Endpoints 89
FormDetails
- GETGets form details.
/v2/accounts/:accountId/forms/:formId/detailsReturns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.
Accounts
- GETGets account information.
/v2/accounts/:accountIdReturns details about a company account.
Documents
- GETGets information about or the contents of a document.
/v2/accounts/:accountId/documents/:documentId?includeContents=falseReturns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format. To find… - DELETEDeletes a specified document.
/v2/accounts/:accountId/documents/:documentIdPermanently deletes a document. To find the documentId of a document that you want to delete, use the Rooms: GetDocuments method. If the document is deleted… - POSTGrants a user access to a document.
/v2/accounts/:accountId/documents/:documentId/usersGrants a user access to a document. You specify the user's userId in the request body. The response is an object that specifies the access the user has.
ESignPermissionProfiles
- GETGets eSignature Permission Profiles.
/v2/accounts/:accountId/esign_permission_profilesWhen you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the…
Fields
- GETGets a field set.
/v2/accounts/:accountId/field_sets/:fieldSetId?fieldsCustomDataFilters=NoneReturns a field set. This is a set of fields that can appear on a room's Details tab in the console, such as contactName and phone.
ExternalFormFillSessions
- POSTCreates an external form fill session.
/v2/accounts/:accountId/external_form_fill_sessionsReturns a URL for a new external form fill session, based on the roomId and formId that you specify in the formFillSessionForCreate request body.
FormGroups
- GETGets form groups.
/v2/accounts/:accountId/form_groups?count=100&startPosition=0Returns the company form groups to which the current user has access. Permissions You must have a role for which the canManageFormGroups permission is set to… - POSTCreates a form group.
/v2/accounts/:accountId/form_groupsCreates a new form group with the name given in the name property of the request body. Permissions You must have a role for which the canManageFormGroups… - GETGets a form group.
/v2/accounts/:accountId/form_groups/:formGroupIdGet the specified form group. Permissions You must have a role for which the canManageFormGroups permission is set to true. - PUTRenames a form group.
/v2/accounts/:accountId/form_groups/:formGroupIdRenames the specified form group with the name given in the name property of the request. Permissions You must have a role for which the canManageFormGroups… - DELETEDeletes a form group.
/v2/accounts/:accountId/form_groups/:formGroupIdDeletes the specified form group. Permissions You must have a role for which the canManageFormGroups permission is set to true. - GETGets the user's form group forms.
/v2/accounts/:accountId/form_groups/:formGroupId/forms?count=100&startPosition=0Get forms of the specified form group. - POSTRemoves a form from a form group.
/v2/accounts/:accountId/form_groups/:formGroupId/unassign_form/:formIdRemoves the form formId from the form group formGroupId. Permissions You must have a role for which the canManageFormGroups permission is set to true. - POSTAssigns a form to a form group.
/v2/accounts/:accountId/form_groups/:formGroupId/assign_formAssigns the form specified in the formId property of the request to the form group formGroupId. Set the isRequired property in the request body to true if… - POSTGrants an office access to a form group.
/v2/accounts/:accountId/form_groups/:formGroupId/grant_office_access/:officeIdGrants the office officeId access to the form group formGroupId. Permissions You must have a role for which the canManageFormGroups permission is set to true. - POSTRevoke an office's access to a form group.
/v2/accounts/:accountId/form_groups/:formGroupId/revoke_office_access/:officeIdRevoke access to the form group formGroupId from the office officeId. Permissions You must have a role for which the canManageFormGroups permission is set to…
FormLibraries
- GETGets form libraries.
/v2/accounts/:accountId/form_libraries?count=100&startPosition=0Returns a list of form libraries to which the current user has access. Permissions All users can use this method, but the results will differ based on whether… - GETGets the forms in a form library.
/v2/accounts/:accountId/form_libraries/:formLibraryId/forms?count=100&startPosition=0Returns a list of forms to which the current user has access in the specified form library.
ClosingStatuses
- GETGets closing statuses.
/v2/closing_statusesReturns a list of closing statuses, or valid reasons for closing a room. You do not specify an accountId or any other parameters with this method. Permissions…
ContactSides
- GETGets contact sides.
/v2/contact_sidesReturn a list of valid values for transaction contact sides. Note: You do not specify an accountId or any other parameters with this method. Permissions Any…
Countries
- GETGets countries.
/v2/countriesReturns a list of countries that the API supports. This is a list of countries in which you can create an office. You do not specify an accountId or any other…
Currencies
- GETGets valid currencies.
/v2/currenciesReturns a list of valid values for the currencies that you can use for listing, offer, and loan amounts. Note: You do not specify an accountId with this…
FinancingTypes
- GETGets financing types.
/v2/financing_typesReturns a list of possible financing types. Permissions Any user with a valid access token can use this method.
OriginsOfLeads
- GETGets origins of leads.
/v2/origins_of_leadsReturns a list of origins of leads (such as Trulia or Zillow) that you can specify for rooms. Permissions Anyone with a valid access token can call this method.
PropertyTypes
- GETGets property types.
/v2/property_typesReturns a list of property types. Permissions Anyone with a valid access token can call this method.
RoomContactTypes
- GETGets room contact types.
/v2/room_contact_typesReturns a list of room contact types, such as Buyer, Seller, and Listing Agent. Permissions Anyone with a valid access token can call this method.
SellerDecisionTypes
- GETGets seller decision types.
/v2/seller_decision_typesReturns a list of possible seller decision types regarding offers, such as Countered or Rejected. Permissions Any user with a valid access token can use this…
SpecialCircumstanceTypes
- GETGets special circumstance types.
/v2/special_circumstance_typesReturns a list of special circumstance types, such as Short Sale and Foreclosure. These are the values that you can select for the Special circumstances field…
States
- GETGets states.
/v2/statesReturns a list of states. Note: You do not enter an accountId with this method. Permissions Anyone with a valid access token can call this method.
TaskDateTypes
- GETGets task date types.
/v2/task_date_typesReturns a list of date types that you can use with tasks, such as Actual Close Date and Task Due Date. These are the options that appear in the Due Date…
TaskResponsibilityTypes
- GETGets task responsibility types.
/v2/task_responsibility_typesReturns a list of responsibility types that you can assign to users when you add them to a task. Note: You do not specify an accountId with this method.…
TaskStatuses
- GETRetrieves the list of valid task statuses.
/v2/task_statusesReturns a list of valid task statuses.
TimeZones
- GETGets time zones.
/v2/time_zonesGets a list of time zones that you can assign to an office. Note: You do not specify an accountId with this method. Permissions Anyone with a valid access…
TransactionSides
- GETGets transaction sides.
/v2/transaction_sidesReturns a list of real estate transaction sides. Permissions Any user with a valid access token can use this method.
Offices
- GETGets offices.
/v2/accounts/:accountId/offices?count=100&startPosition=0&onlyAccessible=false&search=stringThis method returns a list of offices associated with an account. - POSTCreates an office.
/v2/accounts/:accountId/officesThis method creates an office in a Rooms account. You can configure the following information for the new office: Office name Region Address Country ID and… - GETGets information about an office.
/v2/accounts/:accountId/offices/:officeIdThis method returns information about an office. - DELETEDeletes an office.
/v2/accounts/:accountId/offices/:officeIdThis method deletes an office from a Rooms account. - GETRetrieves the number and type of objects that reference an office.
/v2/accounts/:accountId/offices/:officeId/reference_countsThis method returns a list of each type of object and the number of objects of that type referencing the specified office. Note that an office cannot be…
Regions
- GETGets regions.
/v2/accounts/:accountId/regions?count=100&startPosition=0&managedOnly=falseThis method returns a list of regions that are associated with a Rooms account. - POSTCreates a region.
/v2/accounts/:accountId/regionsThis method creates a new region. When you create a region, you specify only the name. The service will assign and return a region ID (regionId) and a… - GETGets information about a region.
/v2/accounts/:accountId/regions/:regionIdThis method returns information about a specific region. - DELETEDeletes a region.
/v2/accounts/:accountId/regions/:regionIdThis method deletes a region from a Rooms account. - GETRetrieves the number and type of objects that reference a region.
/v2/accounts/:accountId/regions/:regionId/reference_countsThis method returns a list of each type of object and the number of objects of that type referencing the specified region. Note: A region cannot be deleted…
Roles
- GETGets roles.
/v2/accounts/:accountId/roles?onlyAssignable=false&filterContext=&filter=string&startPosition=0&count=100Returns a list of roles associated with a company account. Permissions Any user with a valid access token can call this method. - POSTCreates a role.
/v2/accounts/:accountId/rolesCreates a new company role. Permissions To use this method, you must have the canManageAccount permission set to true. - GETGets a role.
/v2/accounts/:accountId/roles/:roleId?includeIsAssigned=falseReturns details about a role, including the associated permissions. - PUTUpdates a role.
/v2/accounts/:accountId/roles/:roleIdModifies the specified company role. Permissions To use this method, you must have the canManageAccount permission set to true. - DELETEDeletes a role.
/v2/accounts/:accountId/roles/:roleIdDeletes a role from a company account. Permissions To use this method, you must have the canManageAccount permission set to true.
Rooms
- POSTCreates an envelope with the given documents. Returns the eSignature envelope ID of the envelope that was created.
/v2/accounts/:accountId/rooms/:roomId/envelopesCreates an envelope with the given documents. Returns the eSignature envelope ID of the envelope that was created. - GETGets a room's field data.
/v2/accounts/:accountId/rooms/:roomId/field_dataReturns the field data associated with a room. This is the information that appears on the room's Details tab. To better understand the room's field data, use… - PUTUpdates a room's field data.
/v2/accounts/:accountId/rooms/:roomId/field_dataThis method lets you update one or more fields in a room's field data, the information that appears in the room's Details tab. To better understand the room's… - POSTAdds a form to a room.
/v2/accounts/:accountId/rooms/:roomId/formsAdds a form to a room. You specify the form that you want to add in the formForAdd request body. To find the ID of the form that you want to add, use the… - GETGets a room's users.
/v2/accounts/:accountId/rooms/:roomId/users?count=100&startPosition=0&filter=string&sort=This method returns a list of users associated with a room. - POSTInvites a user to a room.
/v2/accounts/:accountId/rooms/:roomId/usersThis method invites an existing or new member to a specific room. You can invite anyone to join a room by specifying their email address. - PUTUpdates a room user.
/v2/accounts/:accountId/rooms/:roomId/users/:userIdYou can use this method to update the following information for a room user: roleId transactionSideId In the console, this is the Side and role information… - POSTRevokes the specified user's access to the room.
/v2/accounts/:accountId/rooms/:roomId/users/:userId/revoke_accessRevokes the specified user's access to the room. If successful, the HTTP result is 204 (No content), and the response is empty. To revoke access immediately,… - POSTRestores the specified user's access to the room.
/v2/accounts/:accountId/rooms/:roomId/users/:userId/restore_accessRestores the specified user's access to the room. - GETReturns a list of rooms.
/v2/accounts/:accountId/rooms?count=100&startPosition=0&roomStatus=&officeId=0&fieldDataChangedStartDate=string&fieldDataChangedEndDate=string&roomClosedStartDate=string&roomClosedEndDate=stringThis method returns details about the rooms that the current user has permissions to view. The fieldDataChangedStartDate and fieldDataChangedEndDate query… - POSTCreates a room.
/v2/accounts/:accountId/roomsThis method creates a new room. Note: To use this method, your company must have at least one office set up. Permissions You must be assigned to a role that… - GETGets a room.
/v2/accounts/:accountId/rooms/:roomId?includeFieldData=falseThis method returns details about a specific room. - DELETEDeletes a room.
/v2/accounts/:accountId/rooms/:roomIdThis method deletes a room. Note: To use this method, you must be assigned a role that has the Delete Owned Rooms permission set to true in the console. If… - GETGets assignable room-level roles in v6.
/v2/accounts/:accountId/rooms/:roomId/assignable_roles?assigneeEmail=string&filter=string&startPosition=0&count=100This method returns the room-level roles that the current user can assign to the members that they invite to a room. Note: This method works only for Rooms v6… - GETGets a list of documents in a room.
/v2/accounts/:accountId/rooms/:roomId/documents?count=100&startPosition=0&requireContentForDynamicDocuments=false&roomFolderId=0&nameFilter=string&includeArchived=trueThis method returns a list of documents that the current user can access for a specific room. - POSTAdds a document to a room.
/v2/accounts/:accountId/rooms/:roomId/documentsAdds a document to a room. The following properties in the request body are required. The folderId property is optional. All other properties are ignored.… - POSTUploads the contents of a file as a document to a room.
/v2/accounts/:accountId/rooms/:roomId/documents/contentsThis method uploads the contents of file as a room document for the room that you specify. This is a multipart form request. You must include the following… - PUTUpdates the picture for a room.
/v2/accounts/:accountId/rooms/:roomId/pictureUpdates the photo for a room. The image file size limit is approximately 40 MB, and you can use the following image formats: jpg/jpeg png tiff gif In the… - GETGets the field set for a room.
/v2/accounts/:accountId/rooms/:roomId/field_setReturns the field set that a room uses. This is the set of fields that appears on the room's Details tab in the console, such as contactName and phone. You…
RoomFolders
- GETGets a list of room folders accessible to the current user.
/v2/accounts/:accountId/rooms/:roomId/room_folders?startPosition=0&count=100Gets a list of room folders in the specified room that are accessible to the current user.
RoomTemplates
- GETGets room templates.
/v2/accounts/:accountId/room_templates?officeId=0&onlyAssignable=false&onlyEnabled=true&count=100&startPosition=0This method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates.
TaskLists
- GETGets task lists for a room.
/v2/accounts/:accountId/rooms/:roomId/task_listsReturns the task lists associated with a room. Permissions You must either be a member of the room who has been added to one or more tasks, or have one of the… - POSTApplies a task list to a room.
/v2/accounts/:accountId/rooms/:roomId/task_listsApplies a task list to a room, based on the taskTemplateId that you specify in the taskList request body. Note: You must first create a task list template in… - DELETEDeletes a task list from a room.
/v2/accounts/:accountId/task_lists/:taskListIdDeletes the specified task list from a room. If there are attached documents, they will remain in the associated room. Permissions You must have the…
TaskListTemplates
- GETGets task list templates.
/v2/accounts/:accountId/task_list_templates?startPosition=0&count=100Returns all task list templates associated with the active user's company. Permissions Anyone with a valid access token can call this method.
Users
- GETGets a list of users.
/v2/accounts/:accountId/users?filter=string&sort=&defaultOfficeId=0&accessLevel=&titleId=0&roleId=0&status=&lockedOnly=true&startPosition=0&count=100Returns a list of users associated with an account based on the criteria that you specify. - GETGets a user.
/v2/accounts/:accountId/users/:userIdReturns details about the specified user. - PUTUpdates a user's default office.
/v2/accounts/:accountId/users/:userIdChanges a user's default office. This is the office to which the user belongs by default. Permissions You must have at least one of the following permissions… - DELETERemoves a user from a company account.
/v2/accounts/:accountId/users/:userIdRemoves the specified user from the specified account. Permissions To remove a user who has a lower access level, you must have the… - POSTInvites a user to a company account.
/v2/accounts/:accountId/users/invite_userInvites a new user to join a company account. You specify the custom role and access level that you want to give to the user in the invitee request body.… - POSTReinvites a user to join a company account.
/v2/accounts/:accountId/users/:userId/reinviteReinvites an unactivated user to join a company account. Invitations expire after 30 days and can no longer be accepted. Use this method to send a new copy of… - POSTAdds a user to an office.
/v2/accounts/:accountId/users/:userId/add_to_officeAdds an existing user to a single office. You specify the office to which you want to add the user in the designatedOffice request body. To add a user to… - POSTRemoves a user from an office.
/v2/accounts/:accountId/users/:userId/remove_from_officeRemoves a user from a single office. You specify the office from which you want to remove the user in the designatedOffice request body. The user still… - POSTAdds a user to a region.
/v2/accounts/:accountId/users/:userId/add_to_regionAdds an existing user to a region. You specify the region to which you want to add the user in the designatedRegion request body. To add a user to multiple… - POSTRemoves a user from a region.
/v2/accounts/:accountId/users/:userId/remove_from_regionRemoves a user from a single region. You specify the region from which you want to remove the user in the designatedRegion request body. The user still… - POSTLocks a user's account.
/v2/accounts/:accountId/users/:userId/lockLocks the account of the specified user. Use the reason property in the request body to specify why the account was locked. Permissions To lock a user who has… - POSTUnlocks a user's account.
/v2/accounts/:accountId/users/:userId/unlockUnlocks the account of the specified user. Permissions To unlock a user who has a lower access level than you, you must have the…
FormProviders
- GETGets all associations by provider.
/v2/accounts/:accountId/form_providers/:providerId/associations?count=100&startPosition=0Gets all associations by provider.
API details
- Base URL
https://demo.rooms.docusign.com/restapi- Authentication
- An API key in the Authorization header
- Operations
- 89 operations on 70 pathsGET 48POST 27DELETE 8PUT 6
- Main resources
- Rooms 19Users 12FormGroups 10Offices 5Regions 5Roles 5Documents 3TaskLists 3FormLibraries 2Accounts 1
- Response formats
application/jsontext/jsontext/plain- Description format
- Swagger 2.0, API version
v2 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the DocuSign Rooms API - v2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the DocuSign Rooms API - v2 collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets form details.” (GET /v2/accounts/:accountId/forms/:formId/details), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the DocuSign Rooms API - v2?
An API for an integrator to access the features of DocuSign Rooms It is listed under Other and has 89 endpoints.
Who publishes the DocuSign Rooms API - v2?
It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.
What is the base URL of the DocuSign Rooms API - v2?
Requests go to https://demo.rooms.docusign.com/restapi. Endpoint paths are added to this base URL.
How do I authenticate with the DocuSign Rooms API - v2?
With an API key in the Authorization header.
How many endpoints does the DocuSign Rooms API - v2 have?
89 operations on 70 paths (48 GET, 27 POST, 8 DELETE, 6 PUT). The largest groups are Rooms, Users, FormGroups, Offices.
Is forking the DocuSign Rooms API - v2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.