Overview
AlertEvents
AlertGroups
AlertRoutingRules
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
[DEPRECATED] CustomFieldOptions
[DEPRECATED] CustomFields
CustomForms
DashboardPanels
Dashboards
Environments
EscalationPolicies
EscalationLevelsPolicies
EscalationLevelsPath
EscalationLevels
EscalationPaths
FormFieldOptions
FormFieldPlacementConditions
FormFieldPlacements
FormFieldPositions
FormFields
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
- GETList incidents
- POSTCreates an incident
- GETRetrieves an incident
- PUTUpdate an incident
- DELDelete an incident
- PUTMitigate an incident
- PUTResolve an incident
- PUTCancel an incident
- PUTTriage an incident
- PUTRestart an incident
- PUTMark an incident as a duplicate
- POSTAdd subscribers to incident
- DELRemove subscribers from incident
- POSTAssign user to incident
- DELRemove assigned user from incident
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
WebhooksDeliveries
Retrieves a Form Field
Retrieves a specific form_field by id
curl --request GET \
--url https://api.rootly.com/v1/form_fields/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "423c83e6-c048-48e0-9140-b413c8a4712f",
"type": "form_fields",
"attributes": {
"team_id": 127,
"slug": "minus-est-quae-tenetur",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Minus est quae tenetur.",
"description": "Dolorum ut eligendi odit.",
"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-22T22:59:46.290-07:00",
"created_at": "2025-03-22T22:59:46.289-07:00"
},
"relationships": {
"options": {
"data": [
{
"id": "5df38dd7-7635-4131-bb4e-78f3c2784eab",
"type": "form_field_options"
},
{
"id": "0791578f-d78b-43c1-8c31-aa52c9270770",
"type": "form_field_options"
}
]
},
"positions": {
"data": [
{
"id": "6c121b3d-0821-4217-8838-4f4bd2833c0d",
"type": "form_field_positions"
},
{
"id": "554b8b06-3c06-456d-8635-0458d7032721",
"type": "form_field_positions"
},
{
"id": "39b01533-6c3b-489b-9123-3ad85928e989",
"type": "form_field_positions"
},
{
"id": "745b0283-dd3d-4a11-bc9c-bb1c58268ccc",
"type": "form_field_positions"
}
]
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
comma separated if needed. eg: options,positions
options
, positions
Response
Unique ID of the form field
form_fields
The kind of the form field
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
The input kind of the form field
text
, textarea
, select
, multi_select
, date
, datetime
, number
, checkbox
, tags
, rich_text
The value kind of the form field
inherit
, group
, service
, functionality
, user
, catalog_entity
The name of the form field
The slug of the form field
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
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
The default values.
Date of creation
Date of last update
The ID of the catalog used when value_kind is catalog_entity
The description of the form field
Whether the form field is shown on the incident details panel
Whether the form field is enabled
Was this page helpful?
curl --request GET \
--url https://api.rootly.com/v1/form_fields/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "423c83e6-c048-48e0-9140-b413c8a4712f",
"type": "form_fields",
"attributes": {
"team_id": 127,
"slug": "minus-est-quae-tenetur",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Minus est quae tenetur.",
"description": "Dolorum ut eligendi odit.",
"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-22T22:59:46.290-07:00",
"created_at": "2025-03-22T22:59:46.289-07:00"
},
"relationships": {
"options": {
"data": [
{
"id": "5df38dd7-7635-4131-bb4e-78f3c2784eab",
"type": "form_field_options"
},
{
"id": "0791578f-d78b-43c1-8c31-aa52c9270770",
"type": "form_field_options"
}
]
},
"positions": {
"data": [
{
"id": "6c121b3d-0821-4217-8838-4f4bd2833c0d",
"type": "form_field_positions"
},
{
"id": "554b8b06-3c06-456d-8635-0458d7032721",
"type": "form_field_positions"
},
{
"id": "39b01533-6c3b-489b-9123-3ad85928e989",
"type": "form_field_positions"
},
{
"id": "745b0283-dd3d-4a11-bc9c-bb1c58268ccc",
"type": "form_field_positions"
}
]
}
}
}
}