GET
/
v1
/
form_fields
/
{id}
Retrieves a Form Field
curl --request GET \
  --url https://api.rootly.com/v1/form_fields/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "41317a16-3296-4016-8adb-3de028187703",
    "type": "form_fields",
    "attributes": {
      "team_id": 128,
      "slug": "natus-et-ea-minus",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Natus et ea minus.",
      "description": "Corporis quo est quasi.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": true,
      "enabled": true,
      "updated_at": "2025-08-29T15:08:17.865-07:00",
      "created_at": "2025-08-29T15:08:17.865-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "68110341-e8ba-49b4-9f3f-847dde1d4bc0",
            "type": "form_field_options"
          },
          {
            "id": "38062522-04c6-405d-b569-c70e5db04012",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "62c26af6-a256-44bf-9dc0-f5de069243c2",
            "type": "form_field_positions"
          },
          {
            "id": "a315154d-0858-4be5-9415-9f3119f67532",
            "type": "form_field_positions"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
required

Resource UUID

Query Parameters

include
enum<string>

comma separated if needed. eg: options,positions

Available options:
options,
positions

Response

200
application/vnd.api+json

form_field found by slug

The response is of type object.