FormLibraries: GetFormLibraryForms

Returns a list of forms to which the current user has access in the specified form library.

Request

HTTP request

GET /v2/accounts/{accountId}/form_libraries/{formLibraryId}/forms

Parameters

Parameter NameValueDescription
Path Parameters
formLibraryIdstring

(Required) The id of the form library.

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

accountIdstring

(Required) The id of 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 library forms.

FormSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Forms::GetFormLibraryForms

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.

FormSummary

Contains details about a form in a form library.

libraryFormIdstring

The id of the form.

Example: 301f560d-7e7e-4e6e-bddf-063a47cc12c2

namestring

The name of the form.

Example: Short Sale Supplement to Marketing Agreement

lastUpdatedDatestring

The date and time when the form was last updated.

Example: 2017-08-11T19:58:36.18

FormSummaryList

Contains a list of forms in a form library.

forms[FormSummary]

A list of forms.

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.

}} />