Retrieves a Form Field

Overview

Overview

Reference

AlertEvents
AlertGroups
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
Causes
[DEPRECATED] CustomFieldOptions
[DEPRECATED] CustomFields
CustomForms
DashboardPanels
Dashboards
Environments
EscalationPolicies
EscalationLevelsPolicies
EscalationLevelsPath
EscalationLevels
EscalationPaths
FormFieldOptions
FormFieldPlacementConditions
FormFieldPlacements
FormFieldPositions
FormFields
- GET
  List Form Fields
- POST
  Creates a Form Field
- GET
  Retrieves a Form Field
- PUT
  Update a Form Field
- DEL
  Delete a Form Field
FormSetConditions
FormSets
Functionalities
WorkflowTasks
[DEPRECATED] WorkflowCustomFieldSelections
WorkflowFormFieldConditions
WorkflowGroups
WorkflowRuns
Workflows
Heartbeats
IncidentActionItems
[DEPRECATED] IncidentCustomFieldSelections
IncidentEventFunctionalities
IncidentEventServices
IncidentEvents
IncidentFeedbacks
IncidentFormFieldSelections
IncidentPermissionSetBooleans
IncidentPermissionSetResources
IncidentPermissionSets
IncidentRetrospectives
IncidentRetrospectiveSteps
IncidentRoleTasks
IncidentRoles
IncidentStatusPageEvents
IncidentSubStatuses
IncidentTypes
Incidents
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
Pulses
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
Roles
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Shifts
Secrets
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
Users
WebhooksDeliveries
WebhooksEndpoints

GET

form_fields

{id}

curl --request GET \
  --url 'https://api.rootly.com/v1/form_fields/%7Bid%7D?include=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "data": {
    "id": "af87b6bd-d24d-42ca-9953-ff409567aa69",
    "type": "form_fields",
    "attributes": {
      "team_id": 119,
      "slug": "quas-rerum-quam-sint",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Quas rerum quam sint.",
      "description": "Ex repellat atque neque.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form",
        "slack_new_incident_form",
        "slack_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": true,
      "enabled": true,
      "updated_at": "2025-03-07T00:03:44.506-08:00",
      "created_at": "2025-03-07T00:03:44.506-08:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "931d05c3-af8a-4cea-8a7b-e7fd9c024a43",
            "type": "form_field_options"
          },
          {
            "id": "9df07e32-b8c4-4417-916a-29aa2070e435",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "6a5bb719-ac9c-4e66-8a46-1aa42158c092",
            "type": "form_field_positions"
          },
          {
            "id": "c7761be4-2b35-4d2d-afc2-cc67b8c4ae56",
            "type": "form_field_positions"
          },
          {
            "id": "6ac9c4cf-0e81-407a-9144-7f4becc27810",
            "type": "form_field_positions"
          },
          {
            "id": "ed6a0f00-9857-4f79-8211-b4fcfe204ca5",
            "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

string

required

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

data

object

required

data.id

string

required

Unique ID of the form field

data.type

enum<string>

required

Available options:

form_fields

data.attributes

object

required

data.attributes.kind

enum<string>

required

The kind of the form field

Available options:

custom,

title,

summary,

mitigation_message,

resolution_message,

severity,

environments,

types,

services,

causes,

functionalities,

teams,

visibility,

mark_as_test,

mark_as_backfilled,

labels,

notify_emails,

trigger_manual_workflows,

show_ongoing_incidents,

attach_alerts,

mark_as_in_triage,

in_triage_at,

started_at,

detected_at,

acknowledged_at,

mitigated_at,

resolved_at,

closed_at,

manual_starting_datetime_field

data.attributes.input_kind

enum<string>

required

The input kind of the form field

Available options:

text,

textarea,

select,

multi_select,

date,

datetime,

number,

checkbox,

tags,

rich_text

data.attributes.value_kind

enum<string>

required

The value kind of the form field

Available options:

inherit,

group,

service,

functionality,

user,

catalog_entity

data.attributes.name

string

required

The name of the form field

data.attributes.slug

string

required

The slug of the form field

data.attributes.shown

string[]

required

Where the form field is shown. Add custom forms using the custom form's slug field. Or choose a built-in form: web_new_incident_form, web_update_incident_form, web_incident_post_mortem_form, web_incident_mitigation_form, web_incident_resolution_form, web_incident_cancellation_form, web_scheduled_incident_form, web_update_scheduled_incident_form, incident_post_mortem, slack_new_incident_form, slack_update_incident_form, slack_update_incident_status_form, slack_incident_mitigation_form, slack_incident_resolution_form, slack_incident_cancellation_form, slack_scheduled_incident_form, slack_update_scheduled_incident_form

data.attributes.required

string[]

required

Where the form field is required. Add custom forms using the custom form's slug field. Or choose a built-in form: web_new_incident_form, web_update_incident_form, web_incident_post_mortem_form, web_incident_mitigation_form, web_incident_resolution_form, web_incident_cancellation_form, web_scheduled_incident_form, web_update_scheduled_incident_form, slack_new_incident_form, slack_update_incident_form, slack_update_incident_status_form, slack_incident_mitigation_form, slack_incident_resolution_form, slack_incident_cancellation_form, slack_scheduled_incident_form, slack_update_scheduled_incident_form

data.attributes.default_values

string[]

required

The default values.

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.value_kind_catalog_id

string | null

The ID of the catalog used when value_kind is catalog_entity

data.attributes.description

string | null

The description of the form field

data.attributes.show_on_incident_details

boolean

Whether the form field is shown on the incident details panel

data.attributes.enabled

boolean

Whether the form field is enabled

Was this page helpful?

Update a Form FieldUpdate a specific form_field by id

curl --request GET \
  --url 'https://api.rootly.com/v1/form_fields/%7Bid%7D?include=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "data": {
    "id": "af87b6bd-d24d-42ca-9953-ff409567aa69",
    "type": "form_fields",
    "attributes": {
      "team_id": 119,
      "slug": "quas-rerum-quam-sint",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Quas rerum quam sint.",
      "description": "Ex repellat atque neque.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form",
        "slack_new_incident_form",
        "slack_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": true,
      "enabled": true,
      "updated_at": "2025-03-07T00:03:44.506-08:00",
      "created_at": "2025-03-07T00:03:44.506-08:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "931d05c3-af8a-4cea-8a7b-e7fd9c024a43",
            "type": "form_field_options"
          },
          {
            "id": "9df07e32-b8c4-4417-916a-29aa2070e435",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "6a5bb719-ac9c-4e66-8a46-1aa42158c092",
            "type": "form_field_positions"
          },
          {
            "id": "c7761be4-2b35-4d2d-afc2-cc67b8c4ae56",
            "type": "form_field_positions"
          },
          {
            "id": "6ac9c4cf-0e81-407a-9144-7f4becc27810",
            "type": "form_field_positions"
          },
          {
            "id": "ed6a0f00-9857-4f79-8211-b4fcfe204ca5",
            "type": "form_field_positions"
          }
        ]
      }
    }
  }
}