The Docusign Rooms API enables developers to streamline complex agreements with multiple parties, tasks, documents, and stages through secure digital workspaces. It supports real estate and mortgage transactions by bringing each party together in a central location where you can manage transactions, integrate with other Docusign functionality, and track each step of the process.
openapi: 3.0.1
info:
title: DocuSign Rooms API - v2
description: An API for an integrator to access the features of DocuSign Rooms
termsOfService: https://www.docusign.com/company/terms-and-conditions/web
contact:
name: DocuSign Developer Center
url: https://developers.docusign.com
email: [email protected]
version: v2
externalDocs:
description: Rooms API Reference
url: https://developers.docusign.com/docs/rooms-api/reference/
servers:
- url: https://rooms.docusign.com/restapi
security:
- Bearer: []
tags:
- name: Accounts
description: Information about accounts.
- name: ClosingStatuses
description: ""
- name: ContactSides
description: ""
- name: Countries
description: ""
- name: Currencies
description: ""
- name: Documents
description: "Methods to grant access, delete, and get information, including contents, to a document."
- name: ESignPermissionProfiles
description: This resource provides a method that returns a list of the eSignature permission profiles that the current user can assign to a new member.
- name: ExternalFormFillSessions
description: ""
- name: Fields
description: Information about field sets.
- name: FinancingTypes
description: ""
- name: FormDetails
description: |+
This section shows you how to retrieve a form's details.
- name: FormGroups
description: "With the appropriate permissions, form administrators at your company can create form groups, or curated set of forms gathered from the association **form libraries** to which DocuSign provides access. Form groups enable agents to know which forms to add to rooms based on the type of transaction they are working on. When creating groups, administrators can make certain forms required, ensuring compliance. If you don't create groups, agents will have to choose forms they need from a list of association forms."
- name: FormLibraries
description: ""
- name: FormProviders
description: ""
- name: Offices
description: The `Offices` resource enables you to create and manage offices for your company. You can also retrieve the number and type of objects that reference an office.
- name: OriginsOfLeads
description: "In the console, these are the values that can appear on a room's **Details** tab in the **Origin of lead** field."
- name: PropertyTypes
description: "In the console, these are the values that can appear on a room's **Details** tab in the **Property type** field."
- name: Regions
description: ""
- name: Roles
description: |-
Each role is associated with specific permissions. Each new member is assigned a role when you create them, automatically granting them the permissions associated with that role.
Roles use the following permission types to control the actions that users can perform:
- Room
- Room Details
- Documents
- Envelopes
- Member Management
- Company Settings
Rooms enables you to configure custom roles containing permissions that make sense for your company. Because each new member is assigned a role, you must set up these roles before you can invite members to join your account.
Permissions for roles are tied to the `roleId` property and not yet exposed. You can learn more about these permission types and configure them in the console.
### Internal and External Roles
In Rooms, a role can be either internal or external. You assign internal roles to people inside your company. You assign external roles to people outside your company when you invite them to a room.
Each member inside your company has a default company role. However, they can also be assigned additional roles with different permissions on a per-room basis. Regardless of the member's default company role, what they can do in a room is entirely controlled by their role in that particular room.
- name: RoomContactTypes
description: ""
- name: RoomFolders
description: ""
- name: Rooms
description: "A room can hold documents, envelopes, a list of tasks comprising a workflow, and other related information. You can invite others to this space and assign them permissions on a per-room basis."
- name: RoomTemplates
description: "You can use a room template to set the transaction side and task lists for rooms. For example, a broker can create a room template for agents to use. You can enable the room template for all regions and offices, or just for specific ones. You create room templates and the task templates that room templates use in the console."
- name: SellerDecisionTypes
description: ""
- name: SpecialCircumstanceTypes
description: ""
- name: States
description: ""
- name: TaskDateTypes
description: Task date types are the options that appear in the **Due Date** drop-down list when you create a task by using the console.
- name: TaskLists
description: ""
- name: TaskListTemplates
description: "If your administrator created room templates, those room templates may include task lists for you to use."
- name: TaskResponsibilityTypes
description: ""
- name: TaskStatuses
description: ""
- name: TimeZones
description: ""
- name: TransactionSides
description: ""
- name: Users
description: |-
A new user is created when an account administrator or another authorized user sends an invitation to an email address. After the invitation is sent, the user's status is `pending`. When the recipient accepts the invitation, their user status switches to `active`.
## Inviting a user to a room
To invite a user to a room, use the [Rooms_InviteUser](/docs/rooms-api/reference/Rooms/Rooms/InviteUser/) method. You can invite anyone to join a room by specifying their email address.
You must have the `canAddUsersToRooms` permission set to **true** to invite a user to a room.
## Adding a user to a company Rooms account
To invite a user to a company account, use the [Users_inviteUser](/docs/rooms-api/reference/Users/Users/InviteUser/) method.
You must be either an account administrator (Default Admin) or another authorized user who is assigned a company role that has one of the following `userPermissions` set to **true:**
- `canAddMemberAndSetRoleLowerAccessLevel`: Users can add other users who have a lower access level than their own and set those users' roles (in offices or regions that they oversee).
- `canAddMemberAndSetRoleSameAccessLevel`: Users can add other users who have the same access level as their own and set those users' roles (in offices or regions that they oversee or belong to).
**Note:** Before you invite users, DocuSign strongly recommends that you set up custom roles for your company. For more information, see [Roles](/docs/rooms-api/reference/Roles/Roles/).
paths:
/v2/accounts/{accountId}:
get:
tags:
- Accounts
summary: Docusign Gets account information.
description: Returns details about a company account.
operationId: Accounts_GetAccountInformation
parameters:
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
responses:
"200":
description: Account information successfully retrieved
content:
text/plain:
schema:
$ref: '#/components/schemas/AccountSummary'
application/json:
schema:
$ref: '#/components/schemas/AccountSummary'
text/json:
schema:
$ref: '#/components/schemas/AccountSummary'
application/xml:
schema:
$ref: '#/components/schemas/AccountSummary'
text/xml:
schema:
$ref: '#/components/schemas/AccountSummary'
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: GetAccountInformation
x-ds-method: GetAccountInformation
x-ds-service: Accounts
x-ds-in-sdk: true
/v2/accounts/{accountId}/documents/{documentId}:
get:
tags:
- Documents
summary: Docusign Gets information about or the contents of a document.
description: |-
Returns 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 the `documentId` of the document that you want to retrieve, use the Rooms: GetDocuments method.
operationId: Documents_GetDocument
parameters:
- name: documentId
in: path
description: The ID of the document.
required: true
schema:
type: integer
format: int32
- name: includeContents
in: query
description: "When **true,** includes the contents of the document in the `base64Contents` property of the response. The default value is **false.**"
schema:
type: boolean
default: false
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
responses:
"200":
description: Document successfully retrieved.
content:
text/plain:
schema:
$ref: '#/components/schemas/Document'
application/json:
schema:
$ref: '#/components/schemas/Document'
text/json:
schema:
$ref: '#/components/schemas/Document'
application/xml:
schema:
$ref: '#/components/schemas/Document'
text/xml:
schema:
$ref: '#/components/schemas/Document'
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: GetDocument
x-ds-method: GetDocument
x-ds-service: Documents
x-ds-in-sdk: true
delete:
tags:
- Documents
summary: Docusign Deletes a specified document.
description: |-
Permanently 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 successfully, the HTTP response code is 204 (No Content), so the response body is empty.
operationId: Documents_DeleteDocument
parameters:
- name: documentId
in: path
description: The ID of the document.
required: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
responses:
"204":
description: Document has been successfully deleted.
content: {}
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: DeleteDocument
x-ds-method: DeleteDocument
x-ds-service: Documents
x-ds-in-sdk: true
/v2/accounts/{accountId}/documents/{documentId}/users:
post:
tags:
- Documents
summary: Docusign Grants a user access to a document.
description: Grants 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.
operationId: Documents_CreateDocumentUser
parameters:
- name: documentId
in: path
description: The ID of the document.
required: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DocumentUserForCreate'
application/json:
schema:
$ref: '#/components/schemas/DocumentUserForCreate'
text/json:
schema:
$ref: '#/components/schemas/DocumentUserForCreate'
application/*+json:
schema:
$ref: '#/components/schemas/DocumentUserForCreate'
application/xml:
schema:
$ref: '#/components/schemas/DocumentUserForCreate'
text/xml:
schema:
$ref: '#/components/schemas/DocumentUserForCreate'
application/*+xml:
schema:
$ref: '#/components/schemas/DocumentUserForCreate'
required: false
responses:
"201":
description: User successfully granted access to document.
content:
text/plain:
schema:
$ref: '#/components/schemas/DocumentUser'
application/json:
schema:
$ref: '#/components/schemas/DocumentUser'
text/json:
schema:
$ref: '#/components/schemas/DocumentUser'
application/xml:
schema:
$ref: '#/components/schemas/DocumentUser'
text/xml:
schema:
$ref: '#/components/schemas/DocumentUser'
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: CreateDocumentUser
x-ds-method: CreateDocumentUser
x-ds-service: Documents
x-ds-in-sdk: true
x-codegen-request-body-name: body
/v2/accounts/{accountId}/esign_permission_profiles:
get:
tags:
- ESignPermissionProfiles
summary: Docusign Gets eSignature Permission Profiles.
description: "When 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 eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission."
operationId: ESignPermissionProfiles_GetESignPermissionProfiles
parameters:
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
responses:
"200":
description: Permission profiles successfully retrieved.
content:
text/plain:
schema:
$ref: '#/components/schemas/ESignPermissionProfileList'
application/json:
schema:
$ref: '#/components/schemas/ESignPermissionProfileList'
text/json:
schema:
$ref: '#/components/schemas/ESignPermissionProfileList'
application/xml:
schema:
$ref: '#/components/schemas/ESignPermissionProfileList'
text/xml:
schema:
$ref: '#/components/schemas/ESignPermissionProfileList'
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: GetESignPermissionProfiles
x-ds-method: GetESignPermissionProfiles
x-ds-service: ESignPermissionProfiles
x-ds-in-sdk: true
/v2/accounts/{accountId}/external_form_fill_sessions:
post:
tags:
- ExternalFormFillSessions
summary: Docusign Creates an external form fill session.
description: "Returns a URL for a new external form fill session, based on the `roomId` and `formId` that you specify in the `formFillSessionForCreate` request body."
operationId: ExternalFormFillSessions_CreateExternalFormFillSession
parameters:
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ExternalFormFillSessionForCreate'
application/json:
schema:
$ref: '#/components/schemas/ExternalFormFillSessionForCreate'
text/json:
schema:
$ref: '#/components/schemas/ExternalFormFillSessionForCreate'
application/*+json:
schema:
$ref: '#/components/schemas/ExternalFormFillSessionForCreate'
application/xml:
schema:
$ref: '#/components/schemas/ExternalFormFillSessionForCreate'
text/xml:
schema:
$ref: '#/components/schemas/ExternalFormFillSessionForCreate'
application/*+xml:
schema:
$ref: '#/components/schemas/ExternalFormFillSessionForCreate'
required: false
responses:
"201":
description: Created
content:
text/plain:
schema:
$ref: '#/components/schemas/ExternalFormFillSession'
application/json:
schema:
$ref: '#/components/schemas/ExternalFormFillSession'
text/json:
schema:
$ref: '#/components/schemas/ExternalFormFillSession'
application/xml:
schema:
$ref: '#/components/schemas/ExternalFormFillSession'
text/xml:
schema:
$ref: '#/components/schemas/ExternalFormFillSession'
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: CreateExternalFormFillSession
x-ds-method: CreateExternalFormFillSession
x-ds-service: ExternalFormFillSessions
x-ds-in-sdk: true
x-codegen-request-body-name: body
/v2/accounts/{accountId}/field_sets/{fieldSetId}:
get:
tags:
- Fields
summary: Docusign Gets a field set.
description: "Returns 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`."
operationId: Fields_GetFieldSet
parameters:
- name: fieldSetId
in: path
description: |
The ID of the field set.
Example: `4aef602b-xxxx-xxxx-xxxx-08d76696f678`
required: true
schema:
type: string
format: uuid
- name: fieldsCustomDataFilters
in: query
description: |
An comma-separated list that limits the fields to return:
- `IsRequiredOnCreate`: include fields that are required in room creation.
- `IsRequiredOnSubmit`: include fields that are required when submitting a room for review.
style: form
explode: false
schema:
type: array
items:
type: string
enum:
- None
- IsRequiredOnCreate
- IsRequiredOnSubmit
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
responses:
"200":
description: FieldSet successfully retrieved.
content:
text/plain:
schema:
$ref: '#/components/schemas/FieldSet'
application/json:
schema:
$ref: '#/components/schemas/FieldSet'
text/json:
schema:
$ref: '#/components/schemas/FieldSet'
application/xml:
schema:
$ref: '#/components/schemas/FieldSet'
text/xml:
schema:
$ref: '#/components/schemas/FieldSet'
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: GetFieldSet
x-ds-method: GetFieldSet
x-ds-service: Fields
x-ds-in-sdk: true
/v2/accounts/{accountId}/form_groups:
get:
tags:
- FormGroups
summary: Docusign Gets form groups.
description: "Returns the company form groups to which the current user has access.\n\n## Permissions \n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**"
operationId: FormGroups_GetFormGroups
parameters:
- name: count
in: query
description: The number of results to return. This value must be a number between `1` and `100` (default).
schema:
type: integer
format: int32
default: 100
- name: startPosition
in: query
description: The starting zero-based index position of the results set. The default value is `0`.
schema:
type: integer
format: int32
default: 0
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
responses:
"200":
description: Successfully retrieved Form Groups.
content:
text/plain:
schema:
$ref: '#/components/schemas/FormGroupSummaryList'
application/json:
schema:
$ref: '#/components/schemas/FormGroupSummaryList'
text/json:
schema:
$ref: '#/components/schemas/FormGroupSummaryList'
application/xml:
schema:
$ref: '#/components/schemas/FormGroupSummaryList'
text/xml:
schema:
$ref: '#/components/schemas/FormGroupSummaryList'
"400":
description: Bad request. See ErrorCode and Message for details
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
"401":
description: Not authorized to make this request.
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiError'
application/json:
schema:
$ref: '#/components/schemas/ApiError'
text/json:
schema:
$ref: '#/components/schemas/ApiError'
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
text/xml:
schema:
$ref: '#/components/schemas/ApiError'
x-ds-methodname: GetFormGroups
x-ds-method: GetFormGroups
x-ds-service: FormGroups
x-ds-in-sdk: true
post:
tags:
- FormGroups
summary: Docusign Creates a form group.
description: |-
Creates 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` permission is set to **true.**
operationId: FormGroups_CreateFormGroup
parameters:
- name: accountId
in: path
description: The globally unique identifier (GUID) for the account.
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/FormGroupForCreate'
application/json:
schema:
$ref: '#/components/schemas/FormGroupForCreate'
text/json:
schema:
$ref: '#/components/schemas/FormGroupForCreate'
application/*+json:
schema:
$ref: '#/components/schemas/FormGroupForCreate'
application/xml:
schema:
$ref: '#/components/schemas/FormGroupForCreate'
text/xml:
schema:
$ref: '#/components/schemas/FormGroupForCreate'
application/*+xml:
# --- truncated at 32 KB (468 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/docusign/refs/heads/main/openapi/docusign-rooms-openapi-original.yml