Sign in

v2

latestOpenAPI 3.0.32026-07-31890635.1 KB
Document Fields

Get document field

Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.

get/document/field/{fieldId}

Path parameters

fieldIdnumber required

Response

Successful response

envelopeIdstring required
envelopeItemIdstring required
type'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN' required
idnumber required
secondaryIdstring required
recipientIdnumber required
pagenumber required
{"stackTrail":"paths:/document/field/{fieldId}:get:responses:200:content:application/json:schema:properties:positionX","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/document/field/{fieldId}:get:responses:200:content:application/json:schema:properties:positionY","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/document/field/{fieldId}:get:responses:200:content:application/json:schema:properties:width","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/document/field/{fieldId}:get:responses:200:content:application/json:schema:properties:height","oasType":"schema","type":"unknown"}
customTextstring required
insertedboolean required
documentIdnumber nullable
templateIdnumber nullable