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": "f03ca98f-1f23-4652-a64f-d1a26c24d5ff",
    "type": "form_fields",
    "attributes": {
      "team_id": 174,
      "slug": "rerum-a-quisquam-omnis",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Rerum a quisquam omnis.",
      "description": "Neque accusamus ex est.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": true,
      "enabled": true,
      "updated_at": "2025-10-31T18:54:58.514-07:00",
      "created_at": "2025-10-31T18:54:58.514-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "098714c5-9180-40dd-8cda-ad9dbb2782ab",
            "type": "form_field_options"
          },
          {
            "id": "515406e1-4bfe-41f6-a34f-ba9a9211de48",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "c20b150e-3df0-40ae-8f21-2f35cf6656df",
            "type": "form_field_positions"
          },
          {
            "id": "e61a5d4d-c471-401e-835b-e03ef1c1c023",
            "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