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": "<string>",
    "type": "form_fields",
    "attributes": {
      "name": "<string>",
      "shown": [
        "<string>"
      ],
      "required": [
        "<string>"
      ],
      "default_values": [
        "<string>"
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "value_kind_catalog_id": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "show_on_incident_details": true,
      "enabled": true,
      "auto_set_by_catalog_property_id": "<string>"
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

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
​
included
object[]