API Categories

The API is separated into major categories. Each category covers one or more resources and the resources’ methods.

CategorySummary
AccountsInformation about accounts.
DocumentsInformation about documents.
ESignPermissionProfilesA 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.
FieldsThis 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.
FormsThe 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.
GlobalResourcesThe 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.
NarAssociationsThe `NarAssociations` resource enables you to retrieve a list of National Association of REALTORS® member associations, such as state and local associations.
OfficesYou can use the API to manage offices in your Rooms account.
RegionsYou can use the API to manage regions associated with your Rooms account.
RolesThe Roles resource enables you to easily manage user permissions.
RoomsThis 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.
RoomTemplatesRoom templates enable your company to standardize the new rooms that users create.
TaskListsThe TaskLists resource helps you keep track of the documents and activities you must complete before you can close a room.
UsersThe Users resource provides methods that enable you to add, update, delete, and manage users.

API Method list

ResourceMethodHTTP MethodEndpoint
AccountsGetAccountInformationGET/restapi/v2/accounts/{accountId}
ClosingStatusesGetClosingStatusesGET/restapi/v2/closing_statuses
ContactSidesGetContactSidesGET/restapi/v2/contact_sides
CountriesGetCountriesGET/restapi/v2/countries
CurrenciesGetCurrenciesGET/restapi/v2/currencies
DocumentsGetDocumentGET/restapi/v2/accounts/{accountId}/documents/{documentId}
ESignPermissionProfilesGetESignPermissionProfilesGET/restapi/v2/accounts/{accountId}/esign_permission_profiles
ExternalFormFillSessionsCreateExternalFormFillSessionPOST/restapi/v2/accounts/{accountId}/external_form_fill_sessions
FieldsGetFieldSetGET/restapi/v2/accounts/{accountId}/field_sets/{fieldSetId}
FinancingTypesGetFinancingTypesGET/restapi/v2/financing_types
FormDetailsGetFormDetailsGET/restapi/v2/accounts/{accountId}/forms/{formId}/details
FormGroupsGetFormGroupsGET/restapi/v2/accounts/{accountId}/form_groups
FormLibrariesGetFormLibrariesGET/restapi/v2/accounts/{accountId}/form_libraries
FormLibrariesGetFormLibraryFormsGET/restapi/v2/accounts/{accountId}/form_libraries/{formLibraryId}/forms
NarAssociationsGetNarAssociationsGET/restapi/v2/accounts/{accountId}/forms/nar_associations
NrdsDeleteUserNrdsIdDELETE/restapi/v2/accounts/{accountId}/users/{userId}/nrds
NrdsUpdateUserNrdsIdPUT/restapi/v2/accounts/{accountId}/users/{userId}/nrds
OfficesCreateOfficePOST/restapi/v2/accounts/{accountId}/offices
OfficesDeleteOfficeDELETE/restapi/v2/accounts/{accountId}/offices/{officeId}
OfficesGetOfficeGET/restapi/v2/accounts/{accountId}/offices/{officeId}
OfficesGetOfficesGET/restapi/v2/accounts/{accountId}/offices
OfficesGetReferenceCountsGET/restapi/v2/accounts/{accountId}/offices/{officeId}/reference_counts
OriginsOfLeadsGetOriginsOfLeadsGET/restapi/v2/origins_of_leads
PropertyTypesGetPropertyTypesGET/restapi/v2/property_types
RegionsCreateRegionPOST/restapi/v2/accounts/{accountId}/regions
RegionsDeleteRegionDELETE/restapi/v2/accounts/{accountId}/regions/{regionId}
RegionsGetRegionGET/restapi/v2/accounts/{accountId}/regions/{regionId}
RegionsGetRegionReferenceCountsGET/restapi/v2/accounts/{accountId}/regions/{regionId}/reference_counts
RegionsGetRegionsGET/restapi/v2/accounts/{accountId}/regions
RolesCreateRolePOST/restapi/v2/accounts/{accountId}/roles
RolesDeleteRoleDELETE/restapi/v2/accounts/{accountId}/roles/{roleId}
RolesGetRoleGET/restapi/v2/accounts/{accountId}/roles/{roleId}
RolesGetRolesGET/restapi/v2/accounts/{accountId}/roles
RolesUpdateRolePUT/restapi/v2/accounts/{accountId}/roles/{roleId}
RoomContactTypesGetRoomContactTypesGET/restapi/v2/room_contact_types
RoomsAddDocumentToRoomPOST/restapi/v2/accounts/{accountId}/rooms/{roomId}/documents
RoomsAddDocumentToRoomViaFileUploadPOST/restapi/v2/accounts/{accountId}/rooms/{roomId}/documents/contents
RoomsAddFormToRoomPOST/restapi/v2/accounts/{accountId}/rooms/{roomId}/forms
RoomsCreateRoomPOST/restapi/v2/accounts/{accountId}/rooms
RoomsDeleteRoomDELETE/restapi/v2/accounts/{accountId}/rooms/{roomId}
RoomsGetAssignableRolesGET/restapi/v2/accounts/{accountId}/rooms/{roomId}/assignable_roles
RoomsGetDocumentsGET/restapi/v2/accounts/{accountId}/rooms/{roomId}/documents
RoomsGetRoomGET/restapi/v2/accounts/{accountId}/rooms/{roomId}
RoomsGetRoomFieldDataGET/restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data
RoomsGetRoomFieldSetGET/restapi/v2/accounts/{accountId}/rooms/{roomId}/field_set
RoomsGetRoomsGET/restapi/v2/accounts/{accountId}/rooms
RoomsGetRoomUsersGET/restapi/v2/accounts/{accountId}/rooms/{roomId}/users
RoomsInviteUserPOST/restapi/v2/accounts/{accountId}/rooms/{roomId}/users
RoomsPutRoomUserPUT/restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}
RoomsUpdatePicturePUT/restapi/v2/accounts/{accountId}/rooms/{roomId}/picture
RoomTemplatesGetRoomTemplatesGET/restapi/v2/accounts/{accountId}/room_templates
SellerDecisionTypesGetSellerDecisionTypesGET/restapi/v2/seller_decision_types
SpecialCircumstanceTypesGetSpecialCircumstanceTypesGET/restapi/v2/special_circumstance_types
StatesGetStatesGET/restapi/v2/states
TaskDateTypesGetTaskDateTypesGET/restapi/v2/task_date_types
TaskListsCreateTaskListPOST/restapi/v2/accounts/{accountId}/rooms/{roomId}/task_lists
TaskListsGetTaskListsGET/restapi/v2/accounts/{accountId}/rooms/{roomId}/task_lists
TaskListTemplatesGetTaskListTemplatesGET/restapi/v2/accounts/{accountId}/task_list_templates
TaskResponsibilityTypesGetTaskResponsibilityTypesGET/restapi/v2/task_responsibility_types
TimeZonesGetTimeZonesGET/restapi/v2/time_zones
TransactionSidesGetTransactionSidesGET/restapi/v2/transaction_sides
UsersAddUserToOfficePOST/restapi/v2/accounts/{accountId}/users/{userId}/add_to_office
UsersAddUserToRegionPOST/restapi/v2/accounts/{accountId}/users/{userId}/add_to_region
UsersGetUserGET/restapi/v2/accounts/{accountId}/users/{userId}
UsersGetUsersGET/restapi/v2/accounts/{accountId}/users
UsersInviteClassicAdminPOST/restapi/v2/accounts/{accountId}/users/invite_classic_admin
UsersInviteClassicAgentPOST/restapi/v2/accounts/{accountId}/users/invite_classic_agent
UsersInviteClassicManagerPOST/restapi/v2/accounts/{accountId}/users/invite_classic_manager
UsersInviteUserPOST/restapi/v2/accounts/{accountId}/users/invite_user
UsersReinviteUserPOST/restapi/v2/accounts/{accountId}/users/{userId}/reinvite
UsersRemoveUserDELETE/restapi/v2/accounts/{accountId}/users/{userId}
UsersRemoveUserFromOfficePOST/restapi/v2/accounts/{accountId}/users/{userId}/remove_from_office
UsersRemoveUserFromRegionPOST/restapi/v2/accounts/{accountId}/users/{userId}/remove_from_region
UsersUpdateUserPUT/restapi/v2/accounts/{accountId}/users/{userId}
}} />