FormLibraries: GetFormLibraries

Returns 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 the company has asked DocuSign to enable RequireOfficeLibraryAssignments functionality. If this functionality is enabled for the account, then the list is filtered based on the offices that the user is in and the libraries that are assigned to those offices. If RequireOfficeLibraryAssignments is not enabled, the API returns all results.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/form_libraries

Parameters

Parameter NameValueDescription
Path Parameters
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 starting zero-based index position of the results set. The default value is 0.

Responses

CodeDescriptionReference
200

Successfully retrieved Form Libraries.

FormLibrarySummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Forms::GetFormLibraries

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.

FormLibrarySummary

Contains details about a specific form library.

formsLibraryIdstring

The id of the form library.

Example: 402c6e2f-5019-4f15-bf41-ff3f249f6da9

namestring

The name of the form library.

Example: MOR - Mainstreet Organization of Realtors

formCountinteger

The number of forms in the form library.

Example: 50

FormLibrarySummaryList

Contains a list of forms libraries.

formsLibrarySummaries[FormLibrarySummary]

A list of form libraries.

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.

}} />