Get envelope field

GET

/envelope/field/{fieldId}

curl --request GET \
  --url https://app.legaldoc.com/api/v2/envelope/field/1 \
  --header 'Authorization: <Authorization>'

Returns an envelope field given an ID

Authorizations

• apiKey

Parameters

Path Parameters

fieldId

required

number

Responses

200

Successful response

Media typeapplication/json

object

envelopeId

required

string

envelopeItemId

required

string

type

required

string

Allowed values: SIGNATURE FREE_SIGNATURE INITIALS NAME EMAIL DATE TEXT NUMBER RADIO CHECKBOX DROPDOWN

id

required

number

secondaryId

required

string

recipientId

required

number

page

required

number

positionX

required

positionY

required

width

required

height

required

customText

required

string

inserted

required

boolean

fieldMeta

required

One of:

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

required

string

default: auto

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: signature

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

string

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: initials

textAlign

string

Allowed values: left center right

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

string

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: name

textAlign

string

Allowed values: left center right

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

required

string

default: auto

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: email

textAlign

string

Allowed values: left center right

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

required

string

default: auto

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: date

textAlign

string

Allowed values: left center right

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

string

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: text

text

string

characterLimit

number

textAlign

string

Allowed values: left center right

lineHeight

number | null

>= 1 <= 10

letterSpacing

number | null

<= 100

verticalAlign

string | null

Allowed values: top middle bottom

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

string

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: number

numberFormat

string | null

value

string

minValue

number | null

maxValue

number | null

textAlign

string

Allowed values: left center right

lineHeight

number | null

>= 1 <= 10

letterSpacing

number | null

<= 100

verticalAlign

string | null

Allowed values: top middle bottom

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

string

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: radio

values

Array<object>

object

id

required

number

checked

required

boolean

value

required

string

direction

required

string

default: vertical

Allowed values: vertical horizontal

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

string

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: checkbox

values

Array<object>

object

id

required

number

checked

required

boolean

value

required

string

validationRule

string

validationLength

number

direction

required

string

default: vertical

Allowed values: vertical horizontal

object

object

label

string

placeholder

string

required

boolean

readOnly

boolean

fontSize

number

default: 12 >= 8 <= 96

overflow

string

Allowed values: auto horizontal vertical crop

type

required

string

Allowed values: dropdown

values

Array<object>

object

value

required

string

defaultValue

string

Example

{
  "type": "SIGNATURE",
  "fieldMeta": {
    "fontSize": 12,
    "overflow": "auto",
    "type": "signature"
  }
}

400

Invalid input data

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Authorization not provided

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Insufficient access

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

404

Not found

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Internal server error

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}