FormDetails: GetFormDetails

Returns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.

Request

HTTP request

GET /v2/accounts/{accountId}/forms/{formId}/details

Parameters

Parameter NameValueDescription
Path Parameters
formIdstring

(Required) The id of the form.

accountIdstring

(Required) The id of the account.

Responses

CodeDescriptionReference
200

Form based on FormId

FormDetails
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Forms::GetFormDetails

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.

FormDetails

This resource contains details about a form, such as the date it was created and last updated, the number of pages, the form owner, and other information.

formIdstring

The id of the form.

Example: 5be324eb-8e0c-4f45-adc1-208065181be9

namestring

The name of the form.

Example: MORe Private Network Addendum

createdDatestring

The UTC date and time when the item was created. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

lastUpdatedDatestring

The UTC date and time when the item was last updated. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

availableOnDatestring

The UTC DateTime when the form was made available or published. (It is possible for a form to be published but not yet available.)

ownerNamestring

The name of the organization that owns the form.

Example: Mainstreet organization of Realtors

versionstring

The version of the form.

Example: 1

numberOfPagesinteger

The number of pages in the form.

Example: 2

}} />