Rooms: GetDocuments

This method returns a list of documents that the current user can access for a specific room.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/documents

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Optional Query Parameters
countinteger

(Optional) The number of results to return. This value must be a number between 1 and 100 (default).

startPositioninteger

(Optional) The index position within the total result set from which to start returning values. The default value is 0.

Responses

CodeDescriptionReference
200

Documents successfully retrieved.

RoomDocumentList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::GetDocuments

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

RoomDocument

An individual document in a room.

documentIdinteger

The ID of the document.

namestring

The file name of the document.

Example: Short Sale Supplement to Marketing Agreement.pdf

ownerIdinteger

The id of the user who owns the document.

sizeinteger

The size of the document in bytes.

folderIdinteger

The id of the folder the document is in.

createdDatestring

The UTC date and time that the document was created or uploaded.

Example: 2019-07-25T22:18:56.95Z

isSignedboolean

When set to true, this property indicates that the document is signed.

docuSignFormIdstring

The id of the corresponding DocuSign form.

RoomDocumentList

A list of documents in a room.

resultSetSizeinteger

The number of results returned in this response.

startPositioninteger

The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is 0.

endPositioninteger

The last zero-based index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. This property is null for the last set of search results.

priorUristring

The URI for the previous chunk of records based on the search request. This property is null for the first set of search results.

documents[RoomDocument]

An array of room documents.

}} />