Skip to main content
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": "849d3554-13fa-470e-a6b3-2fef58b6733a",
    "type": "form_fields",
    "attributes": {
      "team_id": 231,
      "slug": "nostrum-voluptatibus-provident-eaque",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Nostrum voluptatibus provident eaque.",
      "description": "Provident nostrum quo soluta.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": true,
      "enabled": true,
      "updated_at": "2026-02-11T19:14:38.698-08:00",
      "created_at": "2026-02-11T19:14:38.698-08:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "3156fcec-54b9-4833-beb7-b85793beea61",
            "type": "form_field_options"
          },
          {
            "id": "99d9c8b1-f548-4c64-8fff-57e6df5d542a",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "386b1cdd-162d-413b-b954-62ba81d28181",
            "type": "form_field_positions"
          },
          {
            "id": "099f9c2f-8804-41bf-8195-79764226e2b8",
            "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

form_field found by slug

​
data
object
required