Retrieve a field

Retrieves the details of a single field using its unique id.

This endpoint is typically used after an envelope has been sent or completed, particularly when you need to extract the value of a field — such as the input from a text field or the selection from a dropdown. It returns a complete field object including its type, placement, styling, and assigned recipient.

Fields are created as part of the Create Envelope request. If no id was explicitly assigned during creation, one will have been automatically generated.

​

Parameters

GET /v1/fields/:id

{
  "id": "5f66f4705e35d5c49d2a7af7a896b8b4",
  "recipient_id": "255e591c2c9fe1bc99be1ec03075b402",
  "type": "signature",
  "page": 1,
  "anchor": "{{signature}}",
  "x_coordinate": 150,
  "y_coordinate": 400,
  "required": true,
  "read_only": false,
  "collaborative": false,
  "value": "foo",
  "checked": false,
  "height": 30,
  "width": 100,
  "options": [],
  "font_size": 12,
  "font_type": "courier",
  "date_format": "DD/MM/YYYY",
  "created": "2019-12-17T05:30:00Z"
}